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

Documentation generation for Builtin Symbols with the same name and different contexts. #990

Closed
wants to merge 2 commits into from

Conversation

mmatera
Copy link
Contributor

@mmatera mmatera commented Feb 4, 2024

This PR improves the way in which we walk the mathics.builtin package to build the documentation. With these changes

  • some tests that are loaded twice in master are now loaded just once (this reduces in ~300 the number of doctests reported when make doctest runs ).
  • fix the issue in the documentation generation that prevents symbols with the same name and different contexts be loaded.
  • Makes the algorithm more deterministic, simpler, and allows to decompose MathicsMainDocumentation.doc_parts in simpler functions. (as proposed in Doc code revision #984)

…the documentation.

* fix the issue in the documentation generation that prevents symbols with the same name and different contexts be loaded.

* filter top-level modules in collecting chapters
@mmatera mmatera force-pushed the doc-code-another-round-of-tiny-changes-1 branch from 9f77630 to 693ce4a Compare February 5, 2024 05:01
rocky added a commit that referenced this pull request Feb 7, 2024
This PR continues #990 by moving the inner loop that loads chapters in
`MathicsMainDocumentation.doc_part` to a new method
`MathicsMainDocumentation.doc_chapter`. With this change, the "on the
fly" loading of documentation for Pymathics modules loaded in a Django
session now is possible (and is implemented in
Mathics3/mathics-django#201)

---------

Co-authored-by: R. Bernstein <[email protected]>
@mmatera
Copy link
Contributor Author

mmatera commented Mar 14, 2024

Already included in previous merged PR

@mmatera mmatera closed this Mar 14, 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

Successfully merging this pull request may close these issues.

1 participant