You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/user_guide/features/index.rst
+7-15Lines changed: 7 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,31 +12,23 @@ Features
12
12
Uniform Project Layout
13
13
----------------------
14
14
15
-
PTB expects a default project layout following "convention over configuration" when possible and reasonable.
16
-
See the cookie-cutter project template for details, which is part of the python-toolbox workspace and can be found in directory `project-template`.
17
-
You can also generate a project from the template to explore the default structure.
15
+
The PTB expects a default project layout following "convention over configuration" wherever possible and reasonable.
16
+
See the cookie-cutter project template, which can be found in directory `project-template`, for more details.
18
17
For more details on this, please check out section :ref:`Getting Started` section.
19
18
20
19
Nox
21
20
---
22
21
23
22
The most central tool when interacting with the toolbox is :code:`nox`, which is the task runner used across all of Exasol's Python-based projects.
24
-
The toolbox itself provides various standard tasks and a plugin mechanism to extend these tasks if needed. For more information regarding nox, please visit the `nox homepage <https://nox.thea.codes/en/stable/>`_.
23
+
The toolbox itself provides various standard tasks and a plugin mechanism to extend these tasks as needed. For more information regarding nox, please visit the `nox homepage <https://nox.thea.codes/en/stable/>`_.
25
24
26
25
Central files in regards to nox and the toolbox are:
27
26
28
-
- noxfile.py: Standard nox configuration/setup file
29
-
- noxconfig.py: Exasol-specific file containing additional information needed by the standard tasks of the toolbox
27
+
- `noxfile.py`: Standard nox configuration/setup file
28
+
- `noxconfig.py`: Exasol-specific file containing additional information needed by the standard tasks of the toolbox
30
29
31
30
Important Nox Commands
32
31
^^^^^^^^^^^^^^^^^^^^^^
33
32
34
-
* :code:`nox -l` shows a list of all available nox tasks
35
-
* :code:`nox -s <tasks>` run the specified task(s)
36
-
* :code:`nox -s test:typing` runs the type checker on the project
37
-
* :code:`nox -s docs:clean docs:build docs:open`
38
-
#. first task removes the documentation folder
39
-
#. second one builds the documentation
40
-
#. last one opens the documentation in the web browser
41
-
* :code:`nox` without :code:`-s` runs the default task which is
42
-
* :code:`nox -s project:fix` this command runs automated fixes on the code
33
+
* :code:`nox -l` shows a list of all available nox sessions
34
+
* :code:`nox -s <session>` run the specified session(s)
0 commit comments