Commit f849814f authored by Jakob Luettgau's avatar Jakob Luettgau
Browse files

Update documentation.

parent 1e67c1db
......@@ -50,8 +50,8 @@ docs: clean-docs # generate Sphinx HTML documentation, including API docs
$(MAKE) -C docs clean
$(MAKE) -C docs html
docs-show: docs
xdg-open docs/_build/html/index.html
docs-show:
xdg-open docs/build/html/index.html
servedocs: docs # compile the docs watching for changes
watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
......
=========
pydarshan
=========
=======================
PyDarshan Documentation
=======================
Python utilities to interact with Darshan log records of HPC applications.
pydarshan requires darshan-utils (3.2.2+) to be installed.
......@@ -44,13 +44,11 @@ A brief examples showing some of the basic functionality is the following::
Installation
------------
To install use either::
To install in most cases the following will work::
make install
pip install darshan
Or::
python setup.py install
For alternative installation instructions and installation from source refer to :doc:`install`.
Testing
......
pydarshan Documentation
=======================
.. note::
This documenation is only for the Darshan Python bindings, for information on the runtime and utility components refer to `Darshan Runtime and Utilities Documentation <https://www.mcs.anl.gov/research/projects/darshan/>`__.
.. include:: ../README.rst
This documenation is only for the Darshan Python bindings, for documentation for the runtime and utility components refer to <https://www.mcs.anl.gov/research/projects/darshan/>.
.. toctree::
:maxdepth: 2
:caption: Contents:
readme
setup
install
usage
.. toctree::
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment