Merge pull request #168 from pyiron/docs_polish

Polish the docs

.github/workflows/push-pull.yml

@@ -12,7 +12,7 @@ jobs:
     uses: pyiron/actions/.github/workflows/push-pull-main.yml@main
     secrets: inherit
     with:
-      docs-env-files: .ci_support/environment.yml .ci_support/environment-docs.yml
+      docs-env-files: .ci_support/environment.yml
       notebooks-env-files: .ci_support/environment.yml .ci_support/environment-notebooks.yml
       tests-in-python-path: true
       runner-alt2: 'macos-11'

docs/README.md

@@ -4,7 +4,6 @@
 [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/0b4c75adf30744a29de88b5959246882)](https://app.codacy.com/gh/pyiron/pyiron_workflow/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![Coverage Status](https://coveralls.io/repos/github/pyiron/pyiron_workflow/badge.svg?branch=main)](https://coveralls.io/github/pyiron/pyiron_workflow?branch=main)
-
 [![Documentation Status](https://readthedocs.org/projects/pyiron-workflow/badge/?version=latest)](https://pyiron-workflow.readthedocs.io/en/latest/?badge=latest)
 
 [![Anaconda](https://anaconda.org/conda-forge/pyiron_workflow/badges/version.svg)](https://anaconda.org/conda-forge/pyiron_workflow)

docs/conf.py

@@ -37,6 +37,7 @@
 extensions = [
     'myst_parser',
     'nbsphinx',
+    'sphinx_gallery.load_style',
     'sphinx.ext.mathjax',
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
@@ -48,7 +49,10 @@
 templates_path = ['_templates']
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown'
+}
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
@@ -57,7 +61,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'pyiron'
+project = u'pyiron_workflow'
 copyright = u'2021, Max-Planck-Institut für Eisenforschung GmbH - Computational Materials Design (CM) Department ' \
             u'All rights reserved'
 
@@ -235,7 +239,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'pyiron.tex', u'pyiron Documentation',
+  ('index', 'pyiron_workflow.tex', u'pyiron_workflow Documentation',
    u'Max-Planck-Institut für Eisenforschung GmbH - Computational Materials Design (CM) Department', 'manual'),
 ]
 
@@ -266,8 +270,8 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('index',
-     'pyiron',
-     u'pyiron Documentation',
+     'pyiron_workflow',
+     u'pyiron_workflow Documentation',
      [u'Max-Planck-Institut für Eisenforschung GmbH - Computational Materials Design (CM) Department'], 1)
 ]
 
@@ -283,7 +287,7 @@
 texinfo_documents = [
   ('index',
    'pyiron_workflow',
-   u'pyiron Documentation',
+   u'pyiron_workflow Documentation',
    u'Max-Planck-Institut für Eisenforschung GmbH - Computational Materials Design (CM) Department',
    'pyiron_workflow',
    'Graph-based workflow management.',

docs/environment.yml

@@ -2,7 +2,10 @@ channels:
 - conda-forge
 dependencies:
 - ipykernel
+- myst-parser
 - nbsphinx
+- sphinx-gallery
+- sphinx-rtd-theme
 - coveralls
 - coverage
 - bidict =0.22.1
@@ -13,4 +16,3 @@ dependencies:
 - python-graphviz =0.20.1
 - toposort =1.10
 - typeguard =4.1.5
-- myst-parser

docs/index.rst

@@ -9,4 +9,5 @@
 .. toctree::
    :hidden:
 
+   source/examples.rst
    source/indices.rst

docs/source/examples.rst

@@ -0,0 +1,11 @@
+.. _examples:
+
+
+Example Notebooks
+=================
+
+.. nbgallery::
+   :maxdepth: 2
+   :glob:
+
+   notebooks/*

docs/source/indices.rst

@@ -9,4 +9,4 @@ API Documentation
 
 
 .. toctree::
-   :maxdepth:2
+   :maxdepth: 2