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

Api documentation needs reformatting #1582

Closed
Tortar opened this issue Jan 8, 2023 · 1 comment
Closed

Api documentation needs reformatting #1582

Tortar opened this issue Jan 8, 2023 · 1 comment

Comments

@Tortar
Copy link
Contributor

Tortar commented Jan 8, 2023

Subissue of #1580 to document a part that need updates: the api documentation in the docs is not very well formatted, some parts of text are not in the place they should be (e.g. see first lines of https://mesa.readthedocs.io/en/latest/apis/space.html#) and also some parts in methods descriptions can be highlighted in a better way (for example making the arguments bold). Maybe to improve it we can take inspiration to some libraries which do a better job with Sphinx like Networkx (e.g. see how the relevant parts in this api documentation page appears, https://networkx.org/documentation/latest/reference/classes/graph.html) ?

@tpike3 tpike3 added the Sprints! A task that might be good to tackle during sprints! label Apr 16, 2023
@jackiekazil jackiekazil removed the Sprints! A task that might be good to tackle during sprints! label May 17, 2024
@quaquel
Copy link
Member

quaquel commented Oct 29, 2024

closed via #2294

@quaquel quaquel closed this as completed Oct 29, 2024
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

4 participants