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

Set up documentation automation #780

Open
wd60622 opened this issue Dec 10, 2023 · 2 comments
Open

Set up documentation automation #780

wd60622 opened this issue Dec 10, 2023 · 2 comments

Comments

@wd60622
Copy link
Contributor

wd60622 commented Dec 10, 2023

There have been a few recent changes to the document. However, there is no set process to have them updated. Based on the read the docs page, it seems the haven't been updated in 6 years.

I think it would be good to automate this in order to reduce manual tasks while also keeping items up to date

Any thoughts here @AzisK @twheys ?

@AzisK
Copy link

AzisK commented Dec 10, 2023

I don't really have an idea how to do it unless somehow connect tests to documentation and then generate the documentation based on the tests

@wd60622
Copy link
Contributor Author

wd60622 commented Dec 10, 2023

I don't really have an idea how to do it unless somehow connect tests to documentation and then generate the documentation based on the tests

I mean, the documentation would be built off the main branch which would pass all previous requirements including tests so I don't see how quality is much of a concern

Do you think an action after merge to main (passing PRs and all) would solve your concern?

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

No branches or pull requests

2 participants