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.

Sign up for GitHub

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

github workflow diagram, add sphinx mermaid ext #420

Merged
merged 2 commits into from
Aug 14, 2021
Merged

github workflow diagram, add sphinx mermaid ext #420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d00a70d
docs small formatting fix
emiliom Aug 14, 2021
70e8fba
docs: sphinx mermaid diagrams, git wrkflow diagram
emiliom Aug 14, 2021
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
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
sphinx_rtd_theme
sphinx-automodapi
sphinxcontrib-mermaid
numpydoc
3 changes: 2 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@
'sphinx.ext.intersphinx',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.githubpages'
'sphinx.ext.githubpages',
'sphinxcontrib.mermaid'
]

numpydoc_show_class_members = False
Expand Down
22 changes: 18 additions & 4 deletions docs/source/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,20 @@ Please submit questions or report problems via GitHub issues. If you're new to G
see these tips for submitting issues:
`"Creating issues on GitHub" <https://medium.com/nyc-planning-digital/writing-a-proper-github-issue-97427d62a20f>`_.

Git workflow:

.. mermaid::

graph LR
classDef patch fill:#f2ece4
A[master] --> B[stable]
p1([doc patch]):::patch -.-> B
B --> |docs merge| D[release/0.x.y]
A --> C[dev]
p2([code patch]):::patch -.-> C
C --> |dev merge| D
D --> A


Installation for echopype development
-------------------------------------
Expand Down Expand Up @@ -147,19 +161,19 @@ To view the generated HTML files generated by Sphinx, open the
``docs/_build/html/index.html`` in your browser.

Updates to the documentation that are based on the current echopype release (that is,
not involving echopype API changes) should be merged into the GitHub `stable` branch.
not involving echopype API changes) should be merged into the GitHub ``stable`` branch.
These updates will then become available immediately on the default Read The Docs version.
Examples of such updates include fixing spelling mistakes, expanding an explanation, and adding a new section that documents a previously undocumented feature.

Documentation versions
~~~~~~~~~~~~~~~~~~~~~~

`<https://echopype.readthedocs.io>`_ redirects to the documentation `stable` version,
`<https://echopype.readthedocs.io>`_ redirects to the documentation ``stable`` version,
`<https://echopype.readthedocs.io/en/stable/>`_, which is built from the `stable` branch
on the `echopype` GitHub repository. In addition, the `latest` version
on the ``echopype`` GitHub repository. In addition, the ``latest`` version
(`<https://echopype.readthedocs.io/en/latest/>`_) is built from the `master` branch,
while the hidden `dev` version (`<https://echopype.readthedocs.io/en/dev/>`_) is built
from the `dev` branch. Finally, each new echopype release is built as a new release version
from the ``dev`` branch. Finally, each new echopype release is built as a new release version
on Read The Docs. Merging pull requests into any of these three branches or issuing a
new tagged release will automatically result in a new Read The Docs build for the
corresponding version.
Expand Down
1 change: 1 addition & 0 deletions requirements-dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,6 @@ setuptools_scm
sphinx
sphinx-automodapi
sphinx_rtd_theme
sphinxcontrib-mermaid
twine
wheel