Skip to content

📚 DOCS: Update theme and add tutorial#190

Merged
chrisjsewell merged 6 commits intodevelopfrom
update-docs
Jan 13, 2021
Merged

📚 DOCS: Update theme and add tutorial#190
chrisjsewell merged 6 commits intodevelopfrom
update-docs

Conversation

@chrisjsewell
Copy link
Copy Markdown
Member

No description provided.

@chrisjsewell chrisjsewell mentioned this pull request Jan 5, 2021
@chrisjsewell chrisjsewell changed the title initial commit Update documentation Jan 6, 2021
@codecov-io
Copy link
Copy Markdown

codecov-io commented Jan 13, 2021

Codecov Report

Merging #190 (23e181f) into develop (2001fd3) will decrease coverage by 0.01%.
The diff coverage is 100.00%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #190      +/-   ##
===========================================
- Coverage    90.94%   90.94%   -0.00%     
===========================================
  Files           22       22              
  Lines         2924     2923       -1     
===========================================
- Hits          2659     2658       -1     
  Misses         265      265              
Impacted Files Coverage Δ
plumpy/base/state_machine.py 87.25% <ø> (ø)
plumpy/process_comms.py 86.06% <ø> (ø)
plumpy/utils.py 84.56% <ø> (ø)
plumpy/processes.py 92.57% <100.00%> (-0.01%) ⬇️
plumpy/workchains.py 93.82% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2001fd3...23e181f. Read the comment docs.

@chrisjsewell chrisjsewell marked this pull request as ready for review January 13, 2021 11:35
@chrisjsewell chrisjsewell changed the title Update documentation 📚 DOCS: Update theme and add tutorial Jan 13, 2021
@chrisjsewell chrisjsewell merged commit 8b1c583 into develop Jan 13, 2021
@chrisjsewell chrisjsewell deleted the update-docs branch January 13, 2021 11:44
unkcpz pushed a commit to unkcpz/plumpy that referenced this pull request Dec 14, 2024
This commit fully revamps the documentation.
The [sphinx-book-theme](https://sphinx-book-theme.readthedocs.io) is now used, in combination with [MyST-NB](https://myst-nb.readthedocs.io).
This allows for the addition of a tutorial in the form of a Jupyter Notebook,
which is automatically re-run when building the documentation.
The tutorial covers most of the package API,
with some further work required on the `Controller` section.

Some minor improvements have also been made to typing and docstrings.
agoscinski pushed a commit to agoscinski/plumpy that referenced this pull request Apr 13, 2026
This commit fully revamps the documentation.
The [sphinx-book-theme](https://sphinx-book-theme.readthedocs.io) is now used, in combination with [MyST-NB](https://myst-nb.readthedocs.io).
This allows for the addition of a tutorial in the form of a Jupyter Notebook,
which is automatically re-run when building the documentation.
The tutorial covers most of the package API,
with some further work required on the `Controller` section.

Some minor improvements have also been made to typing and docstrings.
agoscinski pushed a commit that referenced this pull request Apr 13, 2026
This commit fully revamps the documentation.
The [sphinx-book-theme](https://sphinx-book-theme.readthedocs.io) is now used, in combination with [MyST-NB](https://myst-nb.readthedocs.io).
This allows for the addition of a tutorial in the form of a Jupyter Notebook,
which is automatically re-run when building the documentation.
The tutorial covers most of the package API,
with some further work required on the `Controller` section.

Some minor improvements have also been made to typing and docstrings.
agoscinski pushed a commit that referenced this pull request Apr 13, 2026
This commit fully revamps the documentation.
The [sphinx-book-theme](https://sphinx-book-theme.readthedocs.io) is now used, in combination with [MyST-NB](https://myst-nb.readthedocs.io).
This allows for the addition of a tutorial in the form of a Jupyter Notebook,
which is automatically re-run when building the documentation.
The tutorial covers most of the package API,
with some further work required on the `Controller` section.

Some minor improvements have also been made to typing and docstrings.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants