Creating a documentation template using Sphinx: #17
Conversation
This file contains hidden or 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
Sphinx is configured to create the documentation for pptx-blueprint. The README.md describes how to build the documentation.
Both articles describe how to setup Sphinx. As I have used them the authors should get credit for it.
timhoffm
reviewed
Oct 16, 2019
| # Add any paths that contain custom static files (such as style sheets) here, | ||
| # relative to this directory. They are copied after the builtin static files, | ||
| # so a file named "default.css" will overwrite the builtin "default.css". | ||
| html_static_path = ['_static'] |
There was a problem hiding this comment.
Maybe already create an empty dir _static.
This would placate sphinx:
WARNING: html_static_path entry '_static' does not exist
| @@ -0,0 +1,7 @@ | |||
| pptx_blueprint | |||
There was a problem hiding this comment.
Was this autogenerated? I don't think we need it for anything. And it makes sphinx moan:
/home/tim/dev/pptx-blueprint/docs/source/modules.rst: WARNING: document isn't included in any toctree
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Sphinx is configured to create the documentation for pptx-blueprint.
The README.md describes how to build the documentation.