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

[DOCS] Automating documentation at pushing #99

Open
modenaxe opened this issue Apr 1, 2021 · 3 comments
Open

[DOCS] Automating documentation at pushing #99

modenaxe opened this issue Apr 1, 2021 · 3 comments

Comments

@modenaxe
Copy link
Owner

modenaxe commented Apr 1, 2021

@renaultJB this looks feasible using the python script approach.

Based on this github-learning course I think it is possible to define an action using a Debian Docker image runs the python files on all the relevant paths at each push. That would be pretty cool I think!

@renaultJB
Copy link
Collaborator

Ok, I've found this on the github marketplace. I've not read it yet but it seems to do what we want.

@modenaxe
Copy link
Owner Author

modenaxe commented Apr 8, 2021

@renaultJB I think this could work. I have done a couple of the GitHub action tutorials, I think I should be able to set it up. Can I try on your sphinx branch?

@renaultJB
Copy link
Collaborator

renaultJB commented Apr 13, 2021

Yes, you can. The generation of the python code to generate numpy style comments is still pretty experimental.
The branch is named sphinx_documentation.
I should add a readme.md in the docs folder to explain how to make it works and what are the requirements.

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