Skip to main content

Client for handadoc to hand over documentations to the webserver.

Project description

Handadoc Client

Coverage Status Build Status PyPi Python Versions Code style: black

handadoc_client is a command line tool for uploading build sphinx html pages to a handadoc webserver.



    $ 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.


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.


  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'.



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


Code style: black

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

handadoc-client-0.0.1a0.dev7.tar.gz (57.4 kB view hashes)

Uploaded Source

Built Distribution

handadoc_client-0.0.1a0.dev7-py2.py3-none-any.whl (11.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page