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

Build docs for experimental modules (including cell space) #2122

Open
EwoutH opened this issue Apr 24, 2024 · 2 comments
Open

Build docs for experimental modules (including cell space) #2122

EwoutH opened this issue Apr 24, 2024 · 2 comments
Labels
docs Release notes label Sprints! A task that might be good to tackle during sprints!

Comments

@EwoutH
Copy link
Contributor

EwoutH commented Apr 24, 2024

Currently docs aren't build for features in mesa/experimental, particularly the cell_space and devs. It would be really usefull to have those docs build in Read the Docs.

It probably requires modifying docs/conf.py.

@EwoutH EwoutH added the docs Release notes label label Apr 24, 2024
@tpike3 tpike3 added the Sprints! A task that might be good to tackle during sprints! label May 18, 2024
@stephenfmann
Copy link

I think it should just require adding experimental.md with the relevant sphinx commands to docs/apis and including it as new line entry in api_main.md. I don't think you need to modify docs/conf.py.

Relatively easy to do but testing it locally would require a whole sphinx setup.

@EwoutH
Copy link
Contributor Author

EwoutH commented Jun 5, 2024

Thanks! Our docs are build in CI so just opening a PR should show us if that’s the case.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Release notes label Sprints! A task that might be good to tackle during sprints!
Projects
None yet
Development

No branches or pull requests

3 participants