Merge pull request #26 from ethan-shanahan/dev

Microstructure copy optimisations and docs improvements

Author: ethan-shanahan

.readthedocs.yml

@@ -6,33 +6,28 @@ version: 2
 
 # Set the OS, Python version and other tools you might need
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.11"
-    # You can also specify other tool versions:
-    # nodejs: "20"
-    # rust: "1.70"
-    # golang: "1.20"
+    python: "3.12"
+  commands:
+    - asdf plugin add pixi
+    - asdf install pixi latest
+    - asdf global pixi latest
+    - pixi install -e docs
+    - pixi run build-docs
+    - mkdir --parents $READTHEDOCS_OUTPUT/
+    - cp --recursive docs/build/** $READTHEDOCS_OUTPUT/
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
   configuration: docs/source/conf.py
-  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
-  # builder: "dirhtml"
-  # Fail on all warnings to avoid broken references
-  # fail_on_warning: true
-
-# Optionally build your docs in additional formats such as PDF and ePub
-# formats:
-#   - pdf
-#   - epub
 
 # Optional but recommended, declare the Python requirements required
 # to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-python:
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs
+# python:
+#   install:
+#     - method: pip
+#       path: .
+#       extra_requirements:
+#         - docs

docs/source/_static/aiida-fans-logo.png

@@ -6,22 +6,38 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'aiida-fans'
-copyright = '2024, Ethan Shanahan'
-author = 'Ethan Shanahan'
+import sys
+
+
+project = "aiida-fans"
+copyright = "2024-%Y, Ethan Shanahan"
+author = "Ethan Shanahan"
+sys.path.append("../../src/")
+from aiida_fans._version import version as version
+from aiida_fans._version import version as release
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = []
 
-templates_path = ['_templates']
+templates_path = ["_templates"]
 exclude_patterns = []
 
-master_doc = 'index'
+master_doc = "index"
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
-html_static_path = ['_static']
+html_favicon = "_static/aiida-fans-logo.png"
+html_logo = "_static/aiida-fans-logo.png"
+html_title = "aiida-fans"
+html_last_updated_fmt = ""
+html_static_path = ["_static"]
+
+html_theme = "sphinx_book_theme"
+html_theme_options = {
+    "repository_url": "https://github.com/ethan-shanahan/aiida-fans",
+    "use_repository_button": True,
+}
+

docs/source/conf.py

@@ -0,0 +1,2 @@
+Changelog
+=========

docs/source/developer_guide/landing.rst

@@ -0,0 +1,58 @@
+#################
+ Developer Guide
+#################
+
+TODO
+
+*********
+ Testing
+*********
+
+TODO
+
+**************
+ Contributing
+**************
+
+TODO
+
+Style Guide
+===========
+
+TODO
+
+Pipeline
+========
+
+TODO
+
+Releasing
+=========
+
+TODO
+
+PyPI
+----
+
+TODO
+
+Conda
+-----
+
+TODO
+
+*************
+ Documenting
+*************
+
+TODO
+
+Building
+========
+
+TODO
+
+Publishing
+==========
+
+TODO