From d737effaf6aa0420fcd5c8dd99f5666fe6763359 Mon Sep 17 00:00:00 2001 From: liamhuber Date: Wed, 17 Jan 2024 16:04:21 -0800 Subject: [PATCH 1/6] Rely on centralized docs env for myst-parser --- .ci_support/environment-docs.yml | 4 ---- .github/workflows/push-pull.yml | 2 +- 2 files changed, 1 insertion(+), 5 deletions(-) delete mode 100644 .ci_support/environment-docs.yml diff --git a/.ci_support/environment-docs.yml b/.ci_support/environment-docs.yml deleted file mode 100644 index 205e035e..00000000 --- a/.ci_support/environment-docs.yml +++ /dev/null @@ -1,4 +0,0 @@ -channels: -- conda-forge -dependencies: - - myst-parser \ No newline at end of file diff --git a/.github/workflows/push-pull.yml b/.github/workflows/push-pull.yml index 341b8af7..5d77861d 100644 --- a/.github/workflows/push-pull.yml +++ b/.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' From 53d6dc651ce7ecc7f82dedbc461abf4f5ded5c23 Mon Sep 17 00:00:00 2001 From: liamhuber Date: Wed, 17 Jan 2024 16:06:10 -0800 Subject: [PATCH 2/6] Conf polish --- docs/conf.py | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 1001b6da..5881053a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,7 +48,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 +60,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 +238,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 +269,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 +286,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.', From 9a988e50cbfbc2534482ba7d3d27093a05366552 Mon Sep 17 00:00:00 2001 From: liamhuber Date: Wed, 17 Jan 2024 16:07:33 -0800 Subject: [PATCH 3/6] Add notebook gallery --- docs/conf.py | 1 + docs/index.rst | 1 + docs/source/examples.rst | 11 +++++++++++ 3 files changed, 13 insertions(+) create mode 100644 docs/source/examples.rst diff --git a/docs/conf.py b/docs/conf.py index 5881053a..15ab975d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -37,6 +37,7 @@ extensions = [ 'myst_parser', 'nbsphinx', + 'sphinx_gallery.load_style', 'sphinx.ext.mathjax', 'sphinx.ext.autodoc', 'sphinx.ext.viewcode', diff --git a/docs/index.rst b/docs/index.rst index a1da2bc7..41541a7e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,4 +9,5 @@ .. toctree:: :hidden: + source/examples.rst source/indices.rst \ No newline at end of file diff --git a/docs/source/examples.rst b/docs/source/examples.rst new file mode 100644 index 00000000..de824f08 --- /dev/null +++ b/docs/source/examples.rst @@ -0,0 +1,11 @@ +.. _examples: + + +Example Notebooks +================= + +.. nbgallery:: + :maxdepth: 2 + :glob: + + notebooks/* \ No newline at end of file From 90b4005fa5277262621554441c02b9b030e4d910 Mon Sep 17 00:00:00 2001 From: liamhuber Date: Wed, 17 Jan 2024 16:07:41 -0800 Subject: [PATCH 4/6] Fix maxdepth typo --- docs/source/indices.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/indices.rst b/docs/source/indices.rst index 2e2007f3..28767e9f 100644 --- a/docs/source/indices.rst +++ b/docs/source/indices.rst @@ -9,4 +9,4 @@ API Documentation .. toctree:: - :maxdepth:2 + :maxdepth: 2 From cc948292c1cad9e371133506bea88fdbefb72a0a Mon Sep 17 00:00:00 2001 From: liamhuber Date: Wed, 17 Jan 2024 16:08:26 -0800 Subject: [PATCH 5/6] Remove line break --- docs/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 40e13367..9b06a860 100644 --- a/docs/README.md +++ b/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) From 8b195bfec071527a2f1b639f0a32b74d79c90d06 Mon Sep 17 00:00:00 2001 From: pyiron-runner Date: Thu, 18 Jan 2024 00:09:24 +0000 Subject: [PATCH 6/6] [dependabot skip] Update env file --- docs/environment.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/environment.yml b/docs/environment.yml index 13d3ebfe..3facc4ff 100644 --- a/docs/environment.yml +++ b/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