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

Improve methods in sage.misc.rest_index_of_methods to fix the documentation of graphs. #36179

Merged
merged 6 commits into from
Sep 10, 2023

Conversation

dcoudert
Copy link
Contributor

@dcoudert dcoudert commented Sep 2, 2023

Fixes #36178.

We ensure that method sage.misc.rest_index_of_methods.gen_thematic_rest_table_index adds the correct links to methods in the thematic tables of the documentation. For instance, some links were missing in the thematic tables of https://doc.sagemath.org/html/en/reference/graphs/sage/graphs/graph.html.

We also fix some links in the documentation.

📝 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 created tests covering the changes.
  • I have updated the documentation accordingly.

⌛ Dependencies

src/sage/graphs/isgci.py Outdated Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented Sep 3, 2023

Documentation preview for this PR (built with commit a48893b; changes) is ready! 🎉

Copy link
Contributor

@fchapoton fchapoton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, looks good and does not break the doc

@dcoudert
Copy link
Contributor Author

dcoudert commented Sep 3, 2023

Thank you.

vbraun pushed a commit to vbraun/sage that referenced this pull request Sep 4, 2023
…` to fix the documentation of graphs.

    
Fixes sagemath#36178.

We ensure that method
`sage.misc.rest_index_of_methods.gen_thematic_rest_table_index` adds the
correct links to methods in the thematic tables of the documentation.
For instance, some links were missing in the thematic tables of https://
doc.sagemath.org/html/en/reference/graphs/sage/graphs/graph.html.

We also fix some links in the documentation.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [x] I have created tests covering the changes.
- [x] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36179
Reported by: David Coudert
Reviewer(s): David Coudert, Frédéric Chapoton
vbraun pushed a commit to vbraun/sage that referenced this pull request Sep 5, 2023
…` to fix the documentation of graphs.

    
Fixes sagemath#36178.

We ensure that method
`sage.misc.rest_index_of_methods.gen_thematic_rest_table_index` adds the
correct links to methods in the thematic tables of the documentation.
For instance, some links were missing in the thematic tables of https://
doc.sagemath.org/html/en/reference/graphs/sage/graphs/graph.html.

We also fix some links in the documentation.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [x] I have created tests covering the changes.
- [x] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36179
Reported by: David Coudert
Reviewer(s): David Coudert, Frédéric Chapoton
@vbraun vbraun merged commit 8674d9f into sagemath:develop Sep 10, 2023
13 checks passed
@mkoeppe mkoeppe added this to the sage-10.2 milestone Sep 10, 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.

Missing links in the thematic tables of the documentation of sage.graphs.graph
4 participants