Documentation builder for Python packages
Project description
Package Description
The Python package GenPackageDoc
generates the documentation of Python
modules. The content of this documentation is taken out of the
docstrings of functions, classes and their methods.
It is possible to extend the documentation by the content of additional text files.
The documentation is generated in two steps:
- The rst sources are converted into LaTeX sources
- The LaTeX sources are converted into a PDF document. This requires a
separately installed LaTeX distribution (recommended: MiKTeX), that
is not part of
GenPackageDoc
.
How to install
Firstly clone the python-genpackagedoc repository to your machine.
git clone https://github.com/test-fullautomation/python-genpackagedoc.git
Use the following command to install this package:
setup.py install
Package Documentation
A detailed documentation of the GenPackageDoc package can be found here: GenPackageDoc.pdf
Feedback
To give us a feedback, you can send an email to Thomas Pollerspöck
In case you want to report a bug or request any interesting feature, please don't hesitate to raise a ticket.
Maintainers
Contributors
License
Copyright 2020-2022 Robert Bosch GmbH
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
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
Built Distribution
Hashes for GenPackageDoc-0.34.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6db91f337a8a87aeaa2c0ec7f9a817424a2aac420dbf56ef2e758eb664a7b8a |
|
MD5 | a45e40674b0019e2f2bc9f1bc34c84da |
|
BLAKE2b-256 | 969987aba0555e8a05a9b532814a5d326e9fe05641327b07817dcd389867b709 |