Skip to content

Commit d3651e4

Browse files
committed
Merge remote-tracking branch 'origin/documentation/7_add_how_to_edit_guide' into documentation/7_add_how_to_edit_guide
2 parents b49545b + fde6f8b commit d3651e4

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

doc/how_edit_this_docu.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,17 @@ Edit documentation
3636

3737
1. Edit documentation in `doc` directory using `Sphinx reStructuredText`_
3838

39-
2. Build the Documentation locally:
39+
2. Build the documentation locally:
4040

4141
.. code-block:: bash
4242
43-
poetry run nox -s doc:builds
43+
poetry run nox -s docs:build
4444
45-
3. Open the locally built Documentation in your Browser:
45+
3. Open the locally built documentation in your browser:
4646

4747
.. code-block:: bash
4848
49-
poetry run nox -s doc:open
49+
poetry run nox -s docs:open
5050
5151
4. When finished editing
5252

@@ -83,13 +83,13 @@ Preparations
8383
.. image:: images/codespace/poetry_installation.png
8484
:alt: Wait for the installation of poetry
8585

86-
5. Create Branch:
86+
5. Create branch:
8787

8888
.. code-block:: bash
8989
9090
git switch -C documentation/my_awesome_branch
9191
92-
6. Create Poetry Environment:
92+
6. Create poetry environment:
9393

9494
.. code-block:: bash
9595
@@ -104,13 +104,13 @@ Edit documentation
104104

105105
.. code-block:: bash
106106
107-
poetry run nox -s doc:builds
107+
poetry run nox -s docs:build
108108
109109
6. Serve the Documentation:
110110

111111
.. code-block:: bash
112112
113-
poetry run nox -s doc:serve &> /dev/null &
113+
poetry run nox -s docs:serve &> /dev/null &
114114
115115
6. Forward port on Codespace and open the served Documentation:
116116

@@ -129,11 +129,11 @@ And finally create a PR on GitHub.
129129
Stopping or deleting a Codespace
130130
................................
131131

132-
Codespace can cause costs, so stoping or deleting them after use is a good idea.
132+
Codespace can cause costs, so stopping or deleting them after use is a good idea.
133133

134134
1. Go to the `Codespace page <https://github.com/codespaces/>`_
135135

136-
2. Stopping or deleting a Codespace
136+
2. Stop or delete a Codespace
137137

138138
.. image:: images/codespace/stop_codespace.png
139139
:alt: Stopping or deleting a Codespace

noxfile.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
nox.options.sessions = ["project:fix"]
1111

1212

13-
@nox.session(python=False, name="doc:serve")
13+
@nox.session(python=False, name="docs:serve")
1414
def serve_docs(session):
1515
session.run(
1616
sys.executable,

0 commit comments

Comments
 (0)