-
-
Notifications
You must be signed in to change notification settings - Fork 450
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
using :doc:
tag instead of relative links with ../ to html
#36622
Comments
It's actually doesn't quite work, i.e. it needs two runs of
So it's a bit of chicken & egg issue here. |
Can't we just refer to this section by label ( |
yes, this works. We have several ../../ other URLs in docstrings, which are probably not so easy to fix. I'll try adding tags, and corresponding |
OK, the following works. I'll do a PR based on this, to remove as many --- a/src/doc/en/reference/asymptotic/index.rst
+++ b/src/doc/en/reference/asymptotic/index.rst
@@ -1,3 +1,5 @@
+.. _asymptotic:
+
Asymptotic Expansions
=====================
--- a/src/sage/rings/big_oh.py
+++ b/src/sage/rings/big_oh.py
@@ -3,7 +3,7 @@ Big O for various types (power series, p-adics, etc.)
.. SEEALSO::
- - `asymptotic expansions <../../../asymptotic/index.html>`_
+ - :ref:`asymptotic`
- `p-adic numbers <../../../padics/index.html>`_
- `power series <../../../power_series/index.html>`_
- `polynomials <../../../polynomial_rings/index.html>`_
@@ -90,7 +90,7 @@ def O(*x, **kwds):
sage: K(11^-12, 15)
11^-12 + O(11^15)
- We can also work with `asymptotic expansions`_::
+ We can also work with :ref:`asymptotic expansions <asymptotic>`::
sage: A.<n> = AsymptoticRing(growth_group='QQ^n * n^QQ * log(n)^QQ', # needs sage.symbolic
....: coefficient_ring=QQ); A
--- a/src/sage/rings/polynomial/msolve.py
+++ b/src/sage/rings/polynomial/msolve.py
@@ -8,7 +8,7 @@ based on Gröbner bases.
This module provide implementations of some operations on polynomial ideals
based on msolve.
-Note that the `optional package msolve <../../../../spkg/msolve.html>`_ must be installed.
+Note that the :ref:`spkg_msolve` must be installed.
.. SEEALSO::
|
I've put the changes using |
<!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> From sagemath#36622 (comment) <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 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. - [ ] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] 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#37376 Reported by: Matthias Köppe Reviewer(s): Frédéric Chapoton
fixed by #37376 |
<!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> From sagemath#36622 (comment) <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 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. - [ ] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] 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#37376 Reported by: Matthias Köppe Reviewer(s): Frédéric Chapoton
One can use
:doc:
tag here:and it looks much more Sphinxic to me. I propose to do this for many other places where this is present - this would also make these links in pdf docs meaningful.
Originally posted by @dimpase in #36611 (comment)
The text was updated successfully, but these errors were encountered: