@@ -36,17 +36,17 @@ Edit documentation
36
36
37
37
1. Edit documentation in `doc ` directory using `Sphinx reStructuredText `_
38
38
39
- 2. Build the Documentation locally:
39
+ 2. Build the documentation locally:
40
40
41
41
.. code-block :: bash
42
42
43
- poetry run nox -s doc:builds
43
+ poetry run nox -s docs:build
44
44
45
- 3. Open the locally built Documentation in your Browser :
45
+ 3. Open the locally built documentation in your browser :
46
46
47
47
.. code-block :: bash
48
48
49
- poetry run nox -s doc :open
49
+ poetry run nox -s docs :open
50
50
51
51
4. When finished editing
52
52
@@ -83,13 +83,13 @@ Preparations
83
83
.. image :: images/codespace/poetry_installation.png
84
84
:alt: Wait for the installation of poetry
85
85
86
- 5. Create Branch :
86
+ 5. Create branch :
87
87
88
88
.. code-block :: bash
89
89
90
90
git switch -C documentation/my_awesome_branch
91
91
92
- 6. Create Poetry Environment :
92
+ 6. Create poetry environment :
93
93
94
94
.. code-block :: bash
95
95
@@ -104,13 +104,13 @@ Edit documentation
104
104
105
105
.. code-block :: bash
106
106
107
- poetry run nox -s doc:builds
107
+ poetry run nox -s docs:build
108
108
109
109
6. Serve the Documentation:
110
110
111
111
.. code-block :: bash
112
112
113
- poetry run nox -s doc :serve & > /dev/null &
113
+ poetry run nox -s docs :serve & > /dev/null &
114
114
115
115
6. Forward port on Codespace and open the served Documentation:
116
116
@@ -129,11 +129,11 @@ And finally create a PR on GitHub.
129
129
Stopping or deleting a Codespace
130
130
................................
131
131
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.
133
133
134
134
1. Go to the `Codespace page <https://github.com/codespaces/ >`_
135
135
136
- 2. Stopping or deleting a Codespace
136
+ 2. Stop or delete a Codespace
137
137
138
138
.. image :: images/codespace/stop_codespace.png
139
139
:alt: Stopping or deleting a Codespace
0 commit comments