Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
pmbootstrap
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
postmarketOS
pmbootstrap
Merge requests
!2440
Improvements to documentation
Code
Review changes
Check out branch
Download
Patches
Plain diff
Merged
Improvements to documentation
docs-improvements
into
master
Overview
0
Commits
1
Pipelines
5
Changes
15
Merged
Luca Weiss
requested to merge
docs-improvements
into
master
5 months ago
Overview
0
Commits
1
Pipelines
5
Changes
15
Expand
Make sure all Python modules are documented by adding a bit of shell to .ci/docs.sh
Remove non-existing module references from .rst
Fix various warnings from sphinx by adjusting Python docstrings
Add class member docs to ApkindexBlock
Includes a commit from
!2438 (merged)
, so depends on that.
CC
@longnoserob
Edited
5 months ago
by
Luca Weiss
1
0
Merge request reports
Compare
master
version 4
5ac6038a
5 months ago
version 3
7dd47f06
5 months ago
version 2
22733071
5 months ago
version 1
38326122
5 months ago
master (base)
and
latest version
latest version
35cd6408
1 commit,
5 months ago
version 4
5ac6038a
1 commit,
5 months ago
version 3
7dd47f06
2 commits,
5 months ago
version 2
22733071
2 commits,
5 months ago
version 1
38326122
4 commits,
5 months ago
15 files
+
298
−
48
Inline
Compare changes
Side-by-side
Inline
Show whitespace changes
Show one file at a time
Files
15
Search (e.g. *.vue) (Ctrl+P)
.ci/docs.sh
+
16
−
0
Options
@@ -20,6 +20,22 @@ if [ -z "$(command -v sphinx-build)" ]; then
exit
1
fi
# Sanity check docs that all modules are documented.
# Ignore all packages and files named test*
fail
=
0
modules
=
"
$(
find pmb/
-name
"*.py"
|
grep
-v
'/__init__.py'
|
grep
-v
'/test'
|
grep
-v
'/conftest.py'
|
sort
|
sed
's|\.py$||'
|
sed
's|/|.|g'
)
"
for
module
in
$modules
;
do
if
!
grep
-q
"automodule::
$module
"
docs/api/
*
.rst
;
then
echo
"Undocumented module:
$module
"
fail
=
1
fi
done
if
[
"
$fail
"
-eq
1
]
;
then
echo
"ERROR: Found undocumented modules!"
echo
"ERROR: Please add this module to the correct .rst file in docs/api/"
exit
1
fi
sphinx-build
\
docs
\
public
\
Loading