handadocclient 0.1a0.dev4

Client for handadoc to hand over documentations to the webserver.

Handadoc Client

The handadoc-client supplies the functionality for packaging and uploading sphinx documentations to an internal handadoc-server.

Installation

    $ pip install handadoc_client

Alpha Development Status

The current development state of this project is alpha. Towards the beta

• naming of modules, classes and methods will change, since the final wording is not done.
• Code inspections are not finished.
• The documentation is broad or incomplete.
• Testing is not complete, as it is added during the first test phase. At this state mostly doctests are applied at class or function level.

Basic Usage

Read-the-docs for a more detailed documentation.

Contribution

Any contribution by reporting a bug or desired changes are welcomed. The preferred way is to create an issue on the gitlab's project page, to keep track of everything regarding this project.

Contribution of Source Code

Code style

This project follows the recommendations of PEP8. The project is using black as the code formatter.

Workflow

1. Fork the project on Gitlab.
2. Commit changes to your own branch.
3. Submit a pull request from your fork's branch to our branch 'dev'.

Authors

• David Scheliga @gitlab @Linkedin
  • Initial work
  • Maintainer

License

This project is licensed under the GNU GENERAL PUBLIC LICENSE - see the LICENSE file for details

Acknowledge

Code style: black