Update the docs building procedure #165
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lubosmj
force-pushed
the
fix-doc-generating
branch
9 times, most recently
from
e0da99c to
15b95f4
Compare
lubosmj
force-pushed
the
fix-doc-generating
branch
2 times, most recently
from
dc397c6 to
bc6d635
Compare
decko
reviewed
Sep 9, 2024
README.md
Outdated
|
|
||
| Then, run `make docs` and `make servedocs`. |
There was a problem hiding this comment.
This is just for building the docs? What I need to do to reach those docs?
There was a problem hiding this comment.
If you run make docs, it runs: pulp-docs build and if you run make servedocs, it runs: pulp-docs serve. The URL is accessible from the output logs. You can run these commands outside of the oci-env, like so:
$ make docs
pulp-docs build
Building: mkdocs build --config-file /home/lmjachky/Workplace/pulp/pulp_container/venv3/lib64/python3.12/site-packages/pulp_docs/data/mkdocs.yml --site-dir /home/lmjachky/Workplace/pulp/oci_env/site
....
$ make servedocs
pulp-docs serve
Running: mkdocs serve --config-file /home/lmjachky/Workplace/pulp/pulp_container/venv3/lib64/python3.12/site-packages/pulp_docs/data/mkdocs.yml
...
WARNING - [pulp-docs] Disabled features: ['blog']
Blog rendering is disabled for faster reloads.
To enable it, use: -a, --enable-all
INFO - Documentation built in 17.25 seconds
INFO - [10:11:10] Watching paths for changes: 'staging_docs'
INFO - [10:11:10] Serving on http://127.0.0.1:8000/
a7c1440 to
bc2f6ef
Compare
[noissue]
lubosmj
force-pushed
the
fix-doc-generating
branch
from
bc2f6ef to
66a4f8e
Compare
decko
approved these changes
Sep 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[noissue]