Fix sphinx build

etsap-TIMES · Mar 15, 2024 · 27c60fd · 27c60fd
1 parent 5c397a8
commit 27c60fd
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -37,8 +37,11 @@ The documentation is generated by Sphinx and hosted on ReadTheDocs. We use the f
 - `sphinx-copybutton`: to add copy buttons to code blocks
 - `sphinxcontrib-apidoc`: to automatically generate API documentation from the Python package
 
-**TODO**: currently docstrings are in multiple formats. We should pick one of the Google/NumPy styles and change all docstrings to that format:
-https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#google-vs-numpy
+Documentation can be generated locally (after setting up your development environment as described below) by:
+```bash
+cd docs
+make html
+```
 
 ## Development
 
@@ -140,4 +143,4 @@ python -m twine upload dist/*
 
 ## Contributing
 
-This project welcomes contributions and suggestions. See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) and [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
+This project welcomes contributions and suggestions. See [CODE_OF_CONDUCT.md](https://github.com/etsap-TIMES/xl2times/blob/main/CODE_OF_CONDUCT.md) and [CONTRIBUTING.md](https://github.com/etsap-TIMES/xl2times/blob/main/CONTRIBUTING.md) for more details.
diff --git a/docs/conf.py b/docs/conf.py
@@ -32,6 +32,9 @@
 # apidoc_excluded_paths = ['tests']
 # apidoc_separate_modules = True
 
+# To allow `Attributes` block in class docstrings. TODO can we docstring the dataclass attributes directly?
+napoleon_use_ivar = True
+
 # -- Options for autodoc ----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#configuration
 

diff --git a/xl2times/transforms.py b/xl2times/transforms.py
@@ -447,6 +447,7 @@ def process_flexible_import_tables(
     - Removing, adding and renaming columns as needed.
     - Populating index columns.
     - Handing Attribute column and Other Indexes.
+
     See https://iea-etsap.org/docs/Documentation_for_the_TIMES_Model-Part-IV_October-2016.pdf from p16.
 
     Parameters
@@ -608,6 +609,7 @@ def process_user_constraint_tables(
     - Removing, adding and renaming columns as needed.
     - Populating index columns.
     - Handing Attribute column and wildcards.
+
     See https://iea-etsap.org/docs/Documentation_for_the_TIMES_Model-Part-IV_October-2016.pdf from p16.
 
     Parameters