Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate and include man pages from .rst sources #121

Open
ximon18 opened this issue Nov 14, 2024 · 0 comments
Open

Generate and include man pages from .rst sources #121

ximon18 opened this issue Nov 14, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@ximon18
Copy link
Member

ximon18 commented Nov 14, 2024

Using sphinx.

This is something we currently do manually and are doing in more and more projects.

Manual steps are brittle in that they are not necessarily documented or the documentation becomes outdated, an automated process is both self-documenting and has to be kept up-to-date in order to work, and fixes in Ploutos benefit all projects using it at once instead of fixing the process in each project.

Also, having the right versions of the right Python packages installed is an extra burden on the releasing user if they have no edited/generated docs before.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant