This project provides a modular Python-based documentation generator using pydoctor. It automatically generates HTML documentation for specified Python packages and creates an index page with tabs for easy navigation.
- Generates documentation for multiple Python packages
- Creates an index.html with a tabbed interface for easy navigation
- Uses pydoctor for generating detailed API documentation
- Python 3.7+
- pydoctor
- Bootstrap 5.3 (loaded via CDN in the generated HTML)
- tkr_utils
Create a directory for your project
mkdir project_directory_name
cd project_directory_name
Clone the tkr_utils into your project directory
git clone http://github.com/tuckertucker/tkr_utils
cd tkr_utils
pip install -r requirements.txt
cd ..Clone the tkr_docs into your project directory
git clone http://github.com/tuckertucker/tkr_docs
cd tkr_docs
pip install -r requirements.txt
cd ..-
Ensure all requirements are installed:
pip install -r requirements.txt -
Run the main script:
python -m doc_generator.main -
The generated documentation will be available in the
docsdirectory.
To document additional packages, modify the packages_to_document list in doc_generator/main.py.