Merge pull request #186 from vijayvarma392/sphinx_doc

Sphinx doc

docs/.readthedocs.yaml

@@ -0,0 +1,18 @@
+version: 2
+
+build:
+ os: "ubuntu-22.04"
+ tools:
+ python: "3.9"
+ jobs:
+ pre_build:
+ - sphinx-apidoc -o docs/source gw_eccentricity/
+
+# Build from the docs/ directory with Sphinx
+sphinx:
+ configuration: docs/source/conf.py
+
+# Explicitly set the version of Python and its requirements
+python:
+ install:
+ - requirements: docs/requirements.txt

docs/requirements.txt

@@ -0,0 +1,10 @@
+numpydoc==1.5.0
+nbsphinx==0.9.1
+sphinx-tabs==3.4.1 
+numpy==1.24.3
+scipy==1.10.1
+matplotlib==3.7.1
+lalsuite==7.15
+h5py==3.8.0
+# furo==2023.3.27
+myst-parser==1.0.0

docs/source/conf.py

@@ -0,0 +1,51 @@
+# 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
+
+# -- Path setup --------------------------------------------------------------
+import sphinx_rtd_theme
+import pathlib
+import sys
+import os
+sys.path.insert(0, pathlib.Path(__file__).parents[2].resolve().as_posix())
+sys.path.insert(0, os.path.abspath('../gw_eccentricity'))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'gw_eccentricity'
+copyright = '2023, Md Arif Shaikh, Vijay Varma, Harald Pfeiffer'
+author = 'Md Arif Shaikh, Vijay Varma, Harald Pfeiffer'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx_rtd_theme',
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.autosummary',
+ 'sphinx.ext.mathjax',
+ 'numpydoc',
+ 'nbsphinx',
+ 'sphinx.ext.autosectionlabel',
+ 'sphinx_tabs.tabs',
+ "sphinx.ext.viewcode",
+ 'sphinx.ext.doctest',
+ 'sphinx.ext.napoleon',
+ 'myst_parser'
+ ]
+autosummary_generate = True
+numpydoc_show_class_members = False
+source_suffix = ['.rst', '.md', '.txt']
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_static_path = []
+pygments_style = 'sphinx'
+html_theme = 'sphinx_rtd_theme'
+htmlhelp_basename = 'gw_eccentricitydoc'

docs/source/index.rst

@@ -0,0 +1,22 @@
+.. gw_eccentricity documentation master file, created by
+ sphinx-quickstart on Mon Apr 24 23:31:38 2023.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to gw_eccentricity's documentation!
+===========================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ readme
+ modules
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

@@ -0,0 +1,7 @@
+gw_eccentricity
+===============
+
+.. toctree::
+ :maxdepth: 4
+
+ gw_eccentricity

docs/source/readme.rst

@@ -0,0 +1,2 @@
+.. include:: ../../README.md
+ :parser: myst_parser.sphinx_