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: Remove .rst from docs for simpler build #1363

Closed
tpike3 opened this issue Jun 12, 2022 · 3 comments
Closed

Docs: Remove .rst from docs for simpler build #1363

tpike3 opened this issue Jun 12, 2022 · 3 comments
Assignees
Labels
Sprints! A task that might be good to tackle during sprints!

Comments

@tpike3
Copy link
Member

tpike3 commented Jun 12, 2022

Use of .ipynb transitioned to .rst for the Sphinx build can result in desync from readthedocs build and.ipynb files and large diff files.

We need to update to using just .ipynb with Sphinx.

Discussed in #1361

@Corvince
Copy link
Contributor

Corvince commented Jun 12, 2022

To continue the discussion here:

nbsphinx can can evaluate, i.e. run, notebooks once during doc generation, but does not allow interactive notebooks (this would require some backend). This still means we can provide source control friendly unevaluated .ipynb files and they will show just fine.

Re client side ABM modeling:
I think agentscript is the most popular JS ABM library, at least it was some years ago.

Edit: sorry I was misremembering. I just looked it up again and Agentscript is not very popular.

@tpike3 tpike3 self-assigned this Jan 8, 2023
@tpike3 tpike3 added this to the Mesa 2.0 milestone Jan 8, 2023
@tpike3 tpike3 added the Sprints! A task that might be good to tackle during sprints! label Apr 16, 2023
@rht
Copy link
Contributor

rht commented May 14, 2023

#1694 is an attempt to fix this.

Regarding with having an executable tutorial, I think it would work just fine if we provide a Binder/Colab link to the .ipynb files, described in the tutorial themselves.

rht added a commit to rht/mesa that referenced this issue May 15, 2023
rht added a commit to rht/mesa that referenced this issue May 15, 2023
rht added a commit to rht/mesa that referenced this issue Jun 18, 2023
@tpike3
Copy link
Member Author

tpike3 commented Jun 19, 2023

.rst files have been removed

@tpike3 tpike3 closed this as completed Jun 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Sprints! A task that might be good to tackle during sprints!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants