pyTooling/Actions
1
0
Fork 0
mirror of https://github.com/pyTooling/Actions.git synced 2026-02-12 02:56:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

Reworked more documentation sections.

Browse Source
This commit is contained in:
Patrick Lehmann
2022-11-06 21:30:33 +01:00
parent 2e15b32bad
commit 8bc6ca673c
9 changed files with 146 additions and 163 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
doc/RepositoryStructure.rst
View File

@@ -6,16 +6,28 @@ names in default parameters to job templates, almost all can be overwritten if t
structure.
* Python source code is located in a directory named after the Python package name.
* All tests are located in a ``/tests`` directory and separated by testing approach.
* A ``<package>/__init__.py`` should be provided with global package information like: version number, author,
copyrights, license, maintainer, ...
* All tests are located in a ``/tests`` directory and further divided into subdirectories by testing approach.
* E.g. unit tests are located in a ``/tests/unit`` directory.
* The package documentation is located in a ``/doc`` directory.
* Documentation is written with ReStructured Text (ReST) and translated using Sphinx.
* Documentation requirements are listed in a ``/doc/requirements.txt``.
* Dependencies are listed in a ``/requirements.txt``.
* If the build process requires separate dependencies, a ``/build/requirements.txt`` is used.
* If the publishing/distribution process requires separate dependencies, a ``/dist/requirements.txt`` is used.
* To reduce duplication of dependencies, dependency files should recursively call each other with ``-r <path>``.
* All Python project settings are stored in a ``pyproject.toml``.
* The Python package is described in a ``setup.py``.
* Packages are build with ``build`` instead of ``setuptools``.
* A repository overview is given in a ``README.md``.
.. code-block::
@@ -47,4 +59,3 @@ structure.
README.md
requirements.txt
setup.py