Merge pull request #375 from openPMD/doc

Add readthedoc configuration
openPMD · Jun 15, 2023 · 68412de · 68412de
2 parents 00168f5 + 3ddadaa
commit 68412de
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 3 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,23 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+    configuration: docs/source/conf.py
+
+# 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:
+    - requirements: docs/requirements.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,14 @@
+sphinx
+sphinx-design
+sphinx_rtd_theme
+jupyter
+nbsphinx
+wget
+numba
+numpy
+matplotlib
+pygments
+scipy
+h5py
+tqdm
+openpmd_viewer
diff --git a/docs/source/api_reference/particle_tracking.rst b/docs/source/api_reference/particle_tracking.rst
@@ -1,6 +1,4 @@
 Particle tracking: ``ParticleTracker``
--------------------------------------
+--------------------------------------
 
 .. autoclass:: openpmd_viewer.ParticleTracker
-
-    .. automethod::