Skip to content

Commit b3361c5

Browse files
committed
add links to Jupyter tutorials and Examples
1 parent d362177 commit b3361c5

4 files changed

Lines changed: 28 additions & 32 deletions

File tree

‎docs/sphinx/source/conf.py‎

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@
1818
sys.path.insert(0, os.path.abspath('../../..'))
1919
sys.path.insert(0, os.path.abspath('../../../mdf_forge'))
2020
sys.path.insert(0, os.path.abspath('../../../tests'))
21-
import recommonmark
22-
from recommonmark.parser import CommonMarkParser
23-
from recommonmark.transform import AutoStructify
24-
2521

2622
# -- Project information -----------------------------------------------------
2723

@@ -49,7 +45,6 @@
4945
'sphinx.ext.intersphinx',
5046
'sphinx.ext.ifconfig',
5147
'sphinx.ext.napoleon',
52-
'nbsphinx',
5348
'sphinx.ext.mathjax',
5449
'IPython.sphinxext.ipython_console_highlighting',
5550
]
@@ -67,9 +62,12 @@
6762

6863

6964
# Use Markdown and reStructuredText in the same Sphinx project.
70-
source_parsers = {
71-
'.md': CommonMarkParser,
72-
}
65+
# from recommonmark.parser import CommonMarkParser
66+
67+
# source_parsers = {
68+
# '.md': CommonMarkParser,
69+
# }
70+
7371
source_suffix = ['.rst', '.md']
7472

7573
# The master toctree document.
@@ -225,14 +223,4 @@
225223
# Example configuration for inter sphinx: refer to the Python standard library.
226224
#intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
227225

228-
# app setup hook
229-
github_doc_root = 'https://github.com/rtfd/recommonmark/tree/master/doc/'
230-
def setup(app):
231-
app.add_config_value('recommonmark_config', {
232-
'url_resolver': lambda url: github_doc_root + url,
233-
'auto_toc_tree_section': 'Contents',
234-
'enable_eval_rst': True,
235-
'enable_auto_doc_ref': True,
236-
}, True)
237-
app.add_transform(AutoStructify)
238226

‎docs/sphinx/source/index.rst‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Installation
2525
installation_guide.rst
2626

2727
For Developers
28-
~~~~~~~~~~~~~~
28+
--------------
2929

3030
.. image:: https://img.shields.io/pypi/v/mdf_forge.svg
3131
:target: https://pypi.python.org/pypi/mdf-forge
@@ -52,6 +52,24 @@ Documentation and examples
5252
Documentation, including tutorials and examples, can be found in the
5353
``docs`` directory.
5454

55+
Tutorials
56+
---------
57+
58+
#. Introduction (`Jupyter Notebook <https://github.com/materials-data-facility/forge/blob/master/docs/examples/Introduction.ipynb/>`_)
59+
#. Core Query Builder Functions (`Jupyter Notebook <https://github.com/materials-data-facility/forge/blob/master/docs/examples/Core%20Query%20Builder%20Functions.ipynb/>`_)
60+
#. Expanded Query Builder Functions (`Jupyter Notebook <https://github.com/materials-data-facility/forge/blob/master/docs/examples/Expanded%20Query%20Builder%20Functions.ipynb/>`_)
61+
#. General Helper Functions (`Jupyter Notebook <https://github.com/materials-data-facility/forge/blob/master/docs/examples/General%20Helper%20Functions.ipynb/>`_)
62+
#. Field-Specific Helper Functions (`Jupyter Notebook <https://github.com/materials-data-facility/forge/blob/master/docs/examples/Field-Specific%20Helper%20Functions.ipynb/>`_)
63+
#. Data Retrieval Functions (`Jupyter Notebook <https://github.com/materials-data-facility/forge/blob/master/docs/examples/Data%20Retrieval%20Functions.ipynb/>`_)
64+
65+
Examples
66+
--------
67+
68+
#. Example Aggregations (`Jupyter Notebook <https://github.com/materials-data-facility/forge/blob/master/docs/examples/Example%20Aggregations.ipynb/>`_)
69+
#. Example Analysis - Fe-Cr-Al Oxidation (`Jupyter Notebook <https://github.com/materials-data-facility/forge/blob/master/docs/examples/Example%20Analysis%20-%20Fe-Cr-Al%20Oxidation.ipynb/>`_)
70+
#. Example Machine Learning - OQMD (`Jupyter Notebook <https://github.com/materials-data-facility/forge/blob/master/docs/examples/Example%20Machine%20Learning%20-%20OQMD.ipynb/>`_)
71+
#. Example Statistics - MDF Datasets (`Jupyter Notebook <https://github.com/materials-data-facility/forge/blob/master/docs/examples/Example%20Statistics%20-%20MDF%20Datasets.ipynb/>`_)
72+
5573
Requirements
5674
============
5775

‎docs/sphinx/source/modules.rst‎

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,16 @@ forge.module.forge
77
:show-inheritance:
88

99
forge.class.Forge
10-
^^^^^^^^^^^^^^^^^
10+
-----------------
1111
.. autoclass:: forge.Forge
1212
:members:
1313

1414
forge.class.Query
15-
^^^^^^^^^^^^^^^^^
15+
-----------------
1616

1717
.. autoclass:: forge.Query
1818
:members:
1919

20-
forge.module.test_forge
21-
-----------------------
22-
23-
.. automodule:: test_forge
24-
:members:
25-
:undoc-members:
26-
:show-inheritance:
27-
2820
----
2921

3022
:doc:`MDF Forge Home <index>`
Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
Sphinx build and requirements
22
-----------------------------
33

4-
* sphinx
5-
* commonmark==0.5.5
6-
* recommonmark
4+
* sphinx

0 commit comments

Comments
 (0)