Skip to content

Commit

Permalink
Improve User Documentation (#229)
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicoretti authored Jul 31, 2024
1 parent c59ca99 commit fb4f697
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 1 deletion.
3 changes: 3 additions & 0 deletions doc/changes/unreleased.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,6 @@

* #219: Updated project template configuration
* Updated actions/checkout to v4

## 📚 Documentation
* Updated User Documentation
18 changes: 18 additions & 0 deletions doc/user_guide/overview.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Overview
========

Project Layout
--------------

Overall, the toolbox generally expects a certain project layout because it tries to follow the credo "convention over configuration" when possible and reasonable. This expected structure can be better understood by looking at the cookie-cutter project template, which is part of the python-toolbox workspace and can be found in `project-template`. One can also generate a project from the template to explore the default structure. For more details on this, please check out the getting started section.

Nox
---

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.
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 <http://nox.thea.codes/en/stable/>`_.

Central files in regards to nox and the toolbox are:

- noxfile.py: Standard nox configuration/setup file
- noxconfig.py: Exasol-specific file containing additional information needed by the standard tasks of the toolbox
1 change: 1 addition & 0 deletions doc/user_guide/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
.. toctree::
:maxdepth: 2

overview
getting_started
workflows
customization
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ packages = [
{ include = "exasol" },
]
version = "0.14.0"
description = ""
description = "Your one-stop solution for managing all standard tasks and core workflows of your Python project."
authors = [
"Nicola Coretti <[email protected]>"
]
Expand Down

0 comments on commit fb4f697

Please sign in to comment.