Skip to content

Commit c85ead7

Browse files
committed
Remove unneeded steps as in cookiecutter template & .gitignore there
1 parent 893fefb commit c85ead7

File tree

1 file changed

+26
-46
lines changed

1 file changed

+26
-46
lines changed

doc/user_guide/getting_started.rst

Lines changed: 26 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -69,43 +69,23 @@ List all available nox tasks:
6969
7070
nox -l
7171
72-
Build and open the documentation:
73-
74-
.. code-block:: shell
75-
76-
nox -s docs:build docs:open
77-
78-
Execute the unit tests of the project:
79-
80-
.. code-block:: shell
81-
82-
nox -s test:unit
83-
8472
8573
.. _existing:
8674

8775
Integrating Exasol-Toolbox into your Project
8876
--------------------------------------------
8977

90-
1. Add the toolbox as dependency
78+
#. Add the toolbox as dependency
9179
++++++++++++++++++++++++++++++++
9280

9381
.. code-block:: shell
9482
9583
poetry add --group dev exasol-toolbox
9684
97-
2. Fine tune the .gitignore file
98-
+++++++++++++++++++++++++++++++++
99-
Add the standard documentation output folder (*.html-documentation*) to the *.gitignore*.
100-
101-
.. code-block:: shell
102-
103-
echo ".html-documentation" >> .gitignore && git add .gitignore && git commit -m "Add documentation build folder to .gitignore"
104-
105-
3. Provide a project configuration
85+
2. Provide a project configuration
10686
++++++++++++++++++++++++++++++++++
10787
Make sure you provide the required configuration. Configuration for the exasol-toolbox gets provided by creating
108-
a *noxconfig.py* file in the workspace root. This file should contain at least
88+
a ``noxconfig.py`` file in the workspace root. This file should contain at least
10989
a single module constant with the name **PROJECT_CONFIG** pointing to an object,
11090
which is required to to provide the following attributes:
11191

@@ -127,9 +107,9 @@ Alternatively you can use the *noxconfig.py* file bellow and adjust the value of
127107
.. literalinclude:: ../../noxconfig.py
128108
:language: python3
129109

130-
4. Configure the tooling
110+
3. Configure the tooling
131111
++++++++++++++++++++++++
132-
In order to make all standard task work properly, you need add the configuration settings below to your *pyproject.toml*,
112+
In order to make all standard task work properly, you need add the configuration settings below to your ``pyproject.toml``,
133113
and adjust the following settings to your project needs:
134114

135115
* coverage
@@ -144,11 +124,11 @@ and adjust the following settings to your project needs:
144124
:language: toml
145125
:start-after: # Tooling
146126

147-
5. Make the toolbox tasks available
127+
4. Make the toolbox tasks available
148128
+++++++++++++++++++++++++++++++++++
149-
In order to use the standard toolbox task via nox, just import them in your *noxfile.py*.
150-
If you only need the standard tasks provided by the toolbox, your *noxfile.py* is straight
151-
forward, and you just can use the example *noxfile.py* below.
129+
In order to use the standard toolbox task via nox, just import them in your ``noxfile.py``.
130+
If you only need the standard tasks provided by the toolbox, your ``noxfile.py`` is straight
131+
forward, and you just can use the example ``noxfile.py`` below.
152132

153133
.. literalinclude:: ../../noxfile.py
154134
:language: python3
@@ -163,7 +143,7 @@ forward, and you just can use the example *noxfile.py* below.
163143

164144

165145

166-
6. Set up the pre-commit hooks [optional]
146+
5. Set up the pre-commit hooks [optional]
167147
+++++++++++++++++++++++++++++++++++++++++
168148

169149
#. Add a :code:`.pre-commit-config.yaml` file to your project root
@@ -181,27 +161,27 @@ forward, and you just can use the example *noxfile.py* below.
181161
182162
.. _toolbox tasks:
183163

184-
7. Set up for deploying documentation (optional)
185-
++++++++++++++++++++++++++++++++++++++++++++++++
186-
Within the `gh-pages.yml`, we use the GitHub `upload-pages-artifact` and `deploy-pages`
164+
6. Set up deploying documentation (optional)
165+
++++++++++++++++++++++++++++++++++++++++++++
166+
Within the ``gh-pages.yml``, we use the GitHub ``upload-pages-artifact`` and ``deploy-pages``
187167
actions. In order to properly deploy your pages, you'll need to reconfigure the GitHub
188168
Pages settings for the repo:
189169

190-
1. Go to the affected repo's GitHub page
191-
2. Select 'Settings'
192-
3. Scroll down & select 'Pages'
193-
4. Within the 'Build and deployment' section, change 'Source' to 'GitHub Actions'.
170+
#. Go to the affected repo's GitHub page
171+
#. Select 'Settings'
172+
#. Scroll down & select 'Pages'
173+
#. Within the 'Build and deployment' section, change 'Source' to 'GitHub Actions'.
194174

195175
We also need to configure settings for github-pages environment:
196176

197-
1. Go to the affected repo's GitHub page
198-
2. Select 'Settings'
199-
3. Scroll down & select 'Environment'
200-
4. Click on 'github-pages'
201-
5. In the 'Deployment branches and tags', click 'Add deployment branch or tag rule'
202-
6. Select 'Ref type' to be 'Tag' and set the 'Name pattern' to `[0-9]*.[0-9]*.[0-9]*` (or whatever matches that repo's tags)
177+
#. Go to the affected repo's GitHub page
178+
#. Select 'Settings'
179+
#. Scroll down & select 'Environment'
180+
#. Click on 'github-pages'
181+
#. In the 'Deployment branches and tags', click 'Add deployment branch or tag rule'
182+
#. Select 'Ref type' to be 'Tag' and set the 'Name pattern' to `[0-9]*.[0-9]*.[0-9]*` (or whatever matches that repo's tags)
203183

204-
8. Set up for Sonar
184+
7. Set up for Sonar
205185
+++++++++++++++++++
206186
PTB supports using SonarQube Cloud to analyze, visualize, & track linting, security, &
207187
coverage. All of our Python projects are evaluated against the
@@ -263,9 +243,9 @@ For a **private** project
263243
at a later point. In such scenarios, SonarQube analysis will still report its analysis
264244
results to the PR, but it will not prevent the PR from being merged.
265245

266-
9. Go 🥜
246+
8. Go 🥜
267247
+++++++++++++
268-
You are ready to use the toolbox. With *nox -l* you can list all available tasks.
248+
You are ready to use the toolbox. With ``nox -l`` you can list all available tasks.
269249

270250
.. code-block:: console
271251

0 commit comments

Comments
 (0)