Documentation

[luiarthur]

To maintain separate documentation for different versions of your project using pdoc, consider the following approach:

1. Generate Documentation for Each Version:

For each version of your project, generate the documentation and output it to a version-specific directory.

# For version 1.0
pdoc --html --output-dir docs/v1.0 my_package

# For version 2.0
pdoc --html --output-dir docs/v2.0 my_package

2. Organize Documentation Directories:

Structure your docs directory to include subdirectories for each version:

docs/
├── v1.0/
├── v2.0/
└── index.html

3. Automate Documentation Generation:

Implement a script or continuous integration (CI) pipeline to automate the generation and updating of documentation for each version.

4. Serve Documentation:

Host the docs directory on a web server or a static site hosting service to provide access to the documentation.

Additional Considerations:
Version Navigation: Ensure that each version's documentation includes clear navigation links to other versions.

Consistency: Maintain a consistent structure across all versions to facilitate user navigation.
By following this approach, you can effectively manage and present documentation for multiple versions of your project using pdoc.