Skip to content

Commit

Permalink
sphinx documentation 2
Browse files Browse the repository at this point in the history
  • Loading branch information
fobos123deimos committed Nov 25, 2024
1 parent b0aab7e commit 951a038
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 0 deletions.
12 changes: 12 additions & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

import os
import sys
sys.path.insert(0, os.path.abspath('../'))

project = 'Fast Wave'
copyright = '2024, Matheus Gomes Cordeiro'
author = 'Matheus Gomes Cordeiro'
Expand All @@ -26,3 +30,11 @@

html_theme = 'alabaster'
html_static_path = ['_static']

extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
]

html_theme = 'sphinx_rtd_theme'

45 changes: 45 additions & 0 deletions source/fast_wave.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
fast\_wave package
==================

Submodules
----------

fast\_wave.caching module
-------------------------

.. automodule:: fast_wave.caching
:members:
:undoc-members:
:show-inheritance:

fast\_wave.wavefunction\_cython module
--------------------------------------

.. automodule:: fast_wave.wavefunction_cython
:members:
:undoc-members:
:show-inheritance:

fast\_wave.wavefunction\_mpmath module
--------------------------------------

.. automodule:: fast_wave.wavefunction_mpmath
:members:
:undoc-members:
:show-inheritance:

fast\_wave.wavefunction\_numba module
-------------------------------------

.. automodule:: fast_wave.wavefunction_numba
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: fast_wave
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions source/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
fast_wave
=========

.. toctree::
:maxdepth: 4

fast_wave

0 comments on commit 951a038

Please sign in to comment.