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

Missing links in the thematic tables of the documentation of sage.graphs.graph #36178

Closed
2 tasks done
dcoudert opened this issue Sep 2, 2023 · 0 comments · Fixed by #36179
Closed
2 tasks done

Missing links in the thematic tables of the documentation of sage.graphs.graph #36178

dcoudert opened this issue Sep 2, 2023 · 0 comments · Fixed by #36179

Comments

@dcoudert
Copy link
Contributor

dcoudert commented Sep 2, 2023

Steps To Reproduce

Check the online documentation of undirected: https://doc.sagemath.org/html/en/reference/graphs/sage/graphs/graph.html.

Expected Behavior

Each method in the thematic tables must have a link to the documentation of the corresponding method.

Actual Behavior

Some links are missing.

Additional Information

The issue comes from method sage/misc/rest_index_of_methods.py

Environment

- **OS**: macOS 12.6.7
- **Sage Version**: 10.2.beta1

Checklist

  • I have searched the existing issues for a bug report that matches the one I want to file, without success.
  • I have read the documentation and troubleshoot guide
dcoudert added a commit to dcoudert/sage that referenced this issue Sep 2, 2023
@dcoudert dcoudert self-assigned this Sep 2, 2023
vbraun pushed a commit to vbraun/sage that referenced this issue 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 issue 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 pushed a commit to vbraun/sage that referenced this issue Sep 10, 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
@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 a pull request may close this issue.

2 participants