Skip to content

Commit

Permalink
Try autodoc
Browse files Browse the repository at this point in the history
  • Loading branch information
bsweger committed Oct 10, 2024
1 parent 63df45e commit cfdb913
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 10 deletions.
29 changes: 19 additions & 10 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import os
import sys
from datetime import date

# Configuration file for the Sphinx documentation builder.
Expand All @@ -8,9 +10,16 @@
copyright = f"{date.today().year}, Reich Lab @ The University of Massachusetts Amherst"
author = "Reich Lab"

# Add cladetime location to the path, so we can use autodoc to
# generate API documentation from docstrings.
root_path = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
sys.path.insert(0, root_path)

release = "0.1"
# FIXME: get the version dynamically
version = "0.1.0"


# -- General configuration

extensions = [
Expand Down Expand Up @@ -51,16 +60,16 @@
}

# Order sidebar content, placing ads in the left sidebar
html_sidebars = {
"**": [
"sidebar/brand.html",
"sidebar/search.html",
"sidebar/scroll-start.html",
"sidebar/navigation.html",
"sidebar/scroll-end.html",
"sidebar/ethical-ads.html",
]
}
# html_sidebars = {
# "**": [
# "sidebar/brand.html",
# "sidebar/search.html",
# "sidebar/scroll-start.html",
# "sidebar/navigation.html",
# "sidebar/scroll-end.html",
# "sidebar/ethical-ads.html",
# ]
# }


# from https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ Contents

Home <self>
user-guide
reference/index
10 changes: 10 additions & 0 deletions docs/reference/cladetime.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
CladeTime
==========

.. automodule:: cladetime.CladeTime


.. autoclass:: cladetime.CladeTime
:members:
:exclude-members: putrequest
:show-inheritance:
6 changes: 6 additions & 0 deletions docs/reference/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
API Reference
=============

.. toctree::

cladetime

0 comments on commit cfdb913

Please sign in to comment.