Skip to content

Remove cid from toctree and ignore generated files in docs config #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pacrob merged 3 commits into from
Dec 19, 2025
Merged

Remove cid from toctree and ignore generated files in docs config #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e6657e0
remove cid from toctree, not needed
pacrob Dec 19, 2025
afb65e3
remove cid from toctree and ignore generated rst files we do not use
pacrob Dec 19, 2025
7ff2adf
remove unnecessary delete of rst files in makefile docs targets
pacrob Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ build:
os: ubuntu-22.04
tools:
python: "3.10"
commands:
- rm -f docs/cid.rst docs/modules.rst
- python -m sphinx.ext.apidoc -o docs/ cid

sphinx:
configuration: docs/conf.py
Expand Down
2 changes: 0 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,12 @@ coverage: ## check code coverage quickly with the default Python
$(BROWSER) htmlcov/index.html

docs: ## generate Sphinx HTML documentation, including API docs
rm -f docs/cid.rst
sphinx-apidoc -o docs/ --separate --no-toc cid
$(MAKE) -C docs clean
$(MAKE) -C docs html
$(BROWSER) docs/_build/html/index.html

check-docs-ci: ## check documentation for CI
rm -f docs/cid.rst
sphinx-apidoc -o docs/ --separate --no-toc cid
$(MAKE) -C docs clean
$(MAKE) -C docs html
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
exclude_patterns = ['_build', 'modules.rst', 'cid.rst', 'cid.cid.rst', 'cid.base58.rst']

# The reST default role (used for this markup: `text`) to use for all
# documents.
Expand Down
1 change: 0 additions & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Table of contents
installation
usage
api_reference
cid
contributing
authors
history
Expand Down