Merge pull request #482 from CCPBioSim/481-docs-move-the-documentation-to-the-shared-ccpbiosim-sphinx-theme

Move the documentation to the shared CCPBioSim Sphinx theme

Author: harryswift01

.gitignore

@@ -63,8 +63,8 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
-docs/autosummary/
+docs/build/
+docs/source/reference/
 
 # PyBuilder
 target/

README.md

@@ -14,8 +14,8 @@ CodeEntropy
 CodeEntropy is a Python package for computing the configurational entropy of macromolecular systems using forces sampled from molecular dynamics (MD) simulations. It implements the multiscale cell correlation method to provide accurate and efficient entropy estimates, supporting a wide range of applications in molecular simulation and statistical mechanics.
 
 <p align="center">
-    <img src="docs/_static/logos/biosim-codeentropy_logo_light.png#gh-dark-mode-only" alt="CodeEntropy logo" width="300"/>
-    <img src="docs/_static/logos/biosim-codeentropy_logo_dark.png#gh-light-mode-only" alt="CodeEntropy logo" width="300"/>
+    <img src="docs/source/_static/logos/biosim-codeentropy_logo_light.png#gh-dark-mode-only" alt="CodeEntropy logo" width="300"/>
+    <img src="docs/source/_static/logos/biosim-codeentropy_logo_dark.png#gh-light-mode-only" alt="CodeEntropy logo" width="300"/>
 </p>
 
 See [CodeEntropy’s documentation](https://codeentropy.readthedocs.io/en/latest/) for more information.

docs/Makefile

@@ -5,8 +5,8 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = CodeEntropy
-SOURCEDIR     = .
-BUILDDIR      = _build
+SOURCEDIR     = source
+BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help: