Arange documentation pages #11

hkabbech · hkabbech · commit 37dc1fa574cf · 2024-02-17T01:03:05.000+01:00
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -4,7 +4,7 @@ build:
   tools:
     python: "3.8"
 sphinx:
-  configuration: docs/conf.py
+  configuration: docs/source/conf.py
 python:
   install:
   - requirements: requirements.txt
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# Contributing Guidelines
+# Guidelines
 
 First, **thank you** for contributing!
 
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/index.rst b/docs/index.rst
diff --git a/docs/source/analysis.rst b/docs/source/analysis.rst
@@ -0,0 +1,7 @@
+analysis module
+===============
+
+.. automodule:: analysis
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/compute_features.rst b/docs/source/compute_features.rst
@@ -0,0 +1,7 @@
+compute\_features module
+========================
+
+.. automodule:: compute_features
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,33 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../../src/'))
+
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'tracksegnet'
+copyright = '2024, H. Kabbech'
+author = 'H. Kabbech'
+release = '1.0.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ["myst_parser"]
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
diff --git a/docs/source/contributing.md b/docs/source/contributing.md
@@ -0,0 +1,2 @@
+```{include} ../../CONTRIBUTING.md
+```
diff --git a/docs/source/experimental_tracks.rst b/docs/source/experimental_tracks.rst
@@ -0,0 +1,7 @@
+experimental\_tracks module
+===========================
+
+.. automodule:: experimental_tracks
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/generate_lstm_model.rst b/docs/source/generate_lstm_model.rst
@@ -0,0 +1,7 @@
+generate\_lstm\_model module
+============================
+
+.. automodule:: generate_lstm_model
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,30 @@
+.. tracksegnet documentation master file, created by
+   sphinx-quickstart on Fri Feb 16 23:09:32 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+TrackSegNet's documentation!
+============================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Readme:
+
+   readme
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Modules:
+
+   analysis
+   compute_features
+   experimental_tracks
+   generate_lstm_model
+   simulate_tracks
+   utils
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contributing:
+
+   contributing
diff --git a/docs/source/readme.md b/docs/source/readme.md
@@ -0,0 +1,2 @@
+```{include} ../../README.md
+```
diff --git a/docs/source/simulate_tracks.rst b/docs/source/simulate_tracks.rst
@@ -0,0 +1,7 @@
+simulate\_tracks module
+=======================
+
+.. automodule:: simulate_tracks
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/utils.rst b/docs/source/utils.rst
@@ -0,0 +1,7 @@
+utils module
+============
+
+.. automodule:: utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Contributing Guidelines`
	`1`	`+# Guidelines`
`2`	`2`
`3`	`3`	`First, thank you for contributing!`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+```{include} ../../CONTRIBUTING.md
	`2`	+```