update contributing page

popelier-group · May 9, 2024 · 62cc084 · 62cc084
1 parent 008e83f
commit 62cc084
Show file tree

Hide file tree

Showing 4 changed files with 2 additions and 46 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -31,7 +31,8 @@ will run all the tests in the repository. Similarly, you can run specific unit t
 
 # Documentation
 
-[Sphinx](https://www.sphinx-doc.org/en/master/) is used to build the documentation from the source code. The documentation is found in the `docs/source` directory. Additional example `.rst` files are also found there which are incorporated in the final html documentation.
+[Sphinx](https://www.sphinx-doc.org/en/master/) is used to build the documentation from the source code. The documentation is found in the `docs/source` directory. Additional example `.rst` files are also found there which are incorporated in the final html documentation. Examples notebooks and other `.rst` pages which are not automatically created by `sphinx-apidoc` to be displayed in the final documentation must be written manually.
+
 
 To build the documentation locally, run
 

diff --git a/docs/Makefile b/docs/Makefile
@@ -32,17 +32,3 @@ help:
  rm -f source/ichor_cli/modules.rst
 
  @$(SPHINXBUILD) -a -E "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-%: quick
- @$(SPHINXAPIDOC) --implicit-namespaces -d 1 -o source/ichor_core/ ../ichor_core/ichor/
- @$(SPHINXAPIDOC) --implicit-namespaces -d 1 -o source/ichor_cli/ ../ichor_cli/ichor/
- @$(SPHINXAPIDOC) --implicit-namespaces -d 1 -o source/ichor_hpc/ ../ichor_hpc/ichor/
-
- rm -f source/ichor_core/ichor.rst
- rm -f source/ichor_core/modules.rst
- rm -f source/ichor_hpc/ichor.rst
- rm -f source/ichor_hpc/modules.rst
- rm -f source/ichor_cli/ichor.rst
- rm -f source/ichor_cli/modules.rst
-
- @$(SPHINXBUILD) "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/docs_build_instructions.md b/docs/docs_build_instructions.md
diff --git a/docs/index.html b/docs/index.html