docs
¶
Configuration for documentation with Sphinx and ReadTheDocs.
Functions:
|
Copy custom styling for documentation to the desired repository. |
|
Ensure |
|
|
Make the custom stylesheet for the alabaster Sphinx theme. |
|
|
Add |
|
Create the “License” page in the documentation. |
|
Create the “Source” page in the documentation, and add the associated image. |
|
Add configuration for |
Make the custom stylesheet for the ReadTheDocs Sphinx theme. |
|
|
Add configuration for |
|
Update blocks in the documentation |
-
copy_docs_styling
(repo_path, templates)[source]¶ Copy custom styling for documentation to the desired repository.
-
ensure_doc_requirements
(repo_path, templates)[source]¶ Ensure
<docs_dir>/requirements.txt
contains the required entries.
-
make_alabaster_theming
()[source]¶ Make the custom stylesheet for the alabaster Sphinx theme.
- Return type
- Returns
The custom stylesheet.
-
make_docs_license_rst
(repo_path, templates)[source]¶ Create the “License” page in the documentation.
-
make_docs_source_rst
(repo_path, templates)[source]¶ Create the “Source” page in the documentation, and add the associated image.
-
make_readthedocs_theming
()[source]¶ Make the custom stylesheet for the ReadTheDocs Sphinx theme.
- Return type
- Returns
The custom stylesheet.
-
make_rtfd
(repo_path, templates)[source]¶ Add configuration for
ReadTheDocs
.See https://docs.readthedocs.io/en/stable/config-file/v2.html for details