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

* remove cid from toctree, not needed

* remove cid from toctree and ignore generated rst files we do not use

* remove unnecessary delete of rst files in makefile docs targets

Author: pacrob

.readthedocs.yml

@@ -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

Makefile

@@ -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

docs/conf.py

@@ -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.

docs/index.rst

@@ -14,7 +14,6 @@ Table of contents
    installation
    usage
    api_reference
-   cid
    contributing
    authors
    history