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

WIP: Adding Getting Started section to docs #99

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
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
9 changes: 7 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,14 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autodoc',
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.mathjax',
'sphinx.ext.autosummary',
'sphinx.ext.napoleon']
'sphinx.ext.napoleon',
'nbsphinx'
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down Expand Up @@ -176,3 +179,5 @@

# generate stub pages where directed with autosummary
#autosummary_generate = True

nbsphinx_allow_errors = True
6 changes: 6 additions & 0 deletions docs/examples.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
.. _examples:

Examples
========


.. toctree::
:maxdepth: 1

11 changes: 10 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,20 @@ Contributions are very welcome. If you have bug reports or feature requests or q
.. _`Issue Tracker`: https://github.com/alchemistry/alchemlyb/issues
.. _`alchemistry/alchemlyb`: https://github.com/alchemistry/alchemlyb


.. toctree::
:maxdepth: 1
:caption: User Documentation
:caption: Getting Started

install
tutorials
examples

.. toctree::
:maxdepth: 1
:caption: Package Documentation

overview
parsing
preprocessing
estimators
Expand Down
6 changes: 6 additions & 0 deletions docs/overview.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _overview:

Overview of the alchemlyb library
=================================

Something
17 changes: 17 additions & 0 deletions docs/tutorials.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Tutorials
=========

Welcome to alchemlyb!
If you are new to the library, this content is designed to get you up and running with the library as quickly as possible.

The tutorials included here are intended to be run through in the order given below.
They go to great lengths to explain what is being done, but may gloss over some technical details in order to prioritize pedagogical value.

After learning the usage patterns in alchemlyb, you will likely find the :ref:`examples` useful for learning about more detailed use cases.
If you desire more technical detail on the underlying components of the library, we advise you visit the :ref:`overview`.

.. toctree::
:maxdepth: 1

tutorials/10-minutes-to-alchemlyb.ipynb
tutorials/Pandas-Fu.ipynb
Loading