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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add modules to modules/index.rst #35451

Merged
merged 1 commit into from
Apr 13, 2023
Merged

Conversation

crnsh
Copy link
Contributor

@crnsh crnsh commented Apr 7, 2023

Add vector_numpy_integer_dense and vector_numpy_dense so that hyperlinks work again.

馃摎 Description

This attempts to fix #35444 by adding the correct modules in index.rst. Currently Vector_numpy_dense can be accessed through the index page, but not through the Base class link of Vector_double_dense. Need help resolving this issue.

馃摑 Checklist

  • The title is concise, informative, and self-explanatory.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have updated the documentation accordingly.

@mkoeppe

Add vector_numpy_integer_dense and vector_numpy_dense so that
hyperlinks work again.
@crnsh
Copy link
Contributor Author

crnsh commented Apr 7, 2023

Additionally, there are quite a few .pyx files which aren't displayed in the documentation but exist in the codebase. A mini low hanging fruit project might involve identifying all of them and adding them to the documentation. It'll also be insightful to identify why these files aren't included in the documentation. Even though the instructions are in the docs, the reviewer's checklist mentions checking the references docs but these instructions aren't mentioned explicitly, so maybe it got missed?

@github-actions
Copy link

github-actions bot commented Apr 7, 2023

Documentation preview for this PR is ready! 馃帀
Built with commit: 80a3505

@crnsh
Copy link
Contributor Author

crnsh commented Apr 7, 2023

Weirdly enough it's working on the documentation preview. Why would it work here, but not locally? Did I build the documentation incorrectly? I did the basic ./sage --docbuild reference html command

@mkoeppe
Copy link
Member

mkoeppe commented Apr 7, 2023

The reference manual is built as a "multidoc", which requires several passes. make doc-html orchestrates this

@mkoeppe
Copy link
Member

mkoeppe commented Apr 7, 2023

A mini low hanging fruit project might involve identifying all of them and adding them to the documentation. It'll also be insightful to identify why these files aren't included in the documentation

Yes, that would be great!

@vbraun vbraun merged commit 07b7c98 into sagemath:develop Apr 13, 2023
8 of 9 checks passed
@mkoeppe mkoeppe added this to the sage-10.0 milestone Apr 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

No link for base class of Vector_double_dense
3 participants