Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize docs and some fixes #48

Merged
merged 7 commits into from
Jan 30, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
206 changes: 0 additions & 206 deletions docs/source/_static/custom.css

This file was deleted.

16 changes: 13 additions & 3 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,27 @@ API Documentation

.. versionadded:: 1.0.0

This module provides an updated interface for the HOLE_ suite of tools
This toolkit provides an updated interface for the HOLE_ suite of tools
:cite:p:`Smart1993,Smart1996` to analyse an ion channel pore or transporter
pathway :cite:p:`Stelzl2014` as a function of time or arbitrary order
parameters. It replaces :mod:`mdahole2.analysis.hole`.
parameters.

HOLE_ must be installed separately and can be obtained in binary form
from http://www.holeprogram.org/ or as source from
https://github.com/osmart/hole2. (HOLE is open source and available
under the Apache v2.0 license.)

.. _HOLE: http://www.holeprogram.org

Module
------

.. automodule:: mdahole2.analysis
.. automodule:: mdahole2.analysis.hole
:members:

.. automodule:: mdahole2.analysis.utils
:members:

.. automodule:: mdahole2.analysis.templates
:members:

2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_css_files = ['custom.css'] # , 'readable.css']
html_css_files = [] # , 'readable.css']

# Custom sidebar templates, maps document names to template names.
# alabaster sidebars
Expand Down
2 changes: 2 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ Welcome to mdahole2's documentation!
:caption: Contents:

getting_started
usage
api
references

Indices and tables
==================
Expand Down
Loading
Loading