[Darshan-commits] [Git][darshan/darshan][python-cleanup] 2 commits: Fix aggregators documentation generation

[Kevin Harms]

Kevin Harms pushed to branch python-cleanup at darshan / darshan


Commits:
6cc66ff4 by Kevin Harms at 2021-02-25T15:50:34+00:00
Fix aggregators documentation generation

- - - - -
9290f62a by Kevin Harms at 2021-02-25T15:51:27+00:00
Change documentation generation so module doc is first, then submodule doc

- - - - -


2 changed files:

- darshan-util/pydarshan/Makefile
- darshan-util/pydarshan/darshan/experimental/aggregators/__init__.py


Changes:

=====================================
darshan-util/pydarshan/Makefile
=====================================
@@ -48,7 +48,7 @@ coverage:  # check code coverage quickly with the default Python
 
 
 docs: clean-docs # generate Sphinx HTML documentation, including API docs
-	sphinx-apidoc -o docs/ darshan
+	sphinx-apidoc -M -H PyDarshan -o docs/ darshan
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 


=====================================
darshan-util/pydarshan/darshan/experimental/aggregators/__init__.py
=====================================
@@ -1,12 +1,16 @@
 """Aggregator functions are monkey patched into the DarshanReport object during
-initialization of DarshanReport class. These functions are only enabled if the
-`darshan.enable_experimental(True)` function is called.
+initialization of DarshanReport class.
+
+.. note::
+   These functions are only enabled if the `darshan.enable_experimental(True)` function is called.
+
+Example usage::
 
-Example::
   import darshan
   import darshan.report
   dasrhan.enable_experimental(True)
   report = darshan.report.DarshanReport()
   ...
   result = report.agg_ioops()
+
 """



View it on GitLab: https://xgitlab.cels.anl.gov/darshan/darshan/-/compare/bbd9046301950275305b7e1b99629b66f8495295...9290f62a0ee623ddb5ddfd208e407d534cb82eb7

-- 
View it on GitLab: https://xgitlab.cels.anl.gov/darshan/darshan/-/compare/bbd9046301950275305b7e1b99629b66f8495295...9290f62a0ee623ddb5ddfd208e407d534cb82eb7
You're receiving this email because of your account on xgitlab.cels.anl.gov.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mcs.anl.gov/pipermail/darshan-commits/attachments/20210225/0b26cf2a/attachment.html>