sagemath / sage

Main repository of SageMath. Now open for Issues and Pull Requests.
https://www.sagemath.org
Other
1.19k stars 412 forks source link

Doc: Replace all relative links like `../reference/sage/graphs/graph_generators.html` by `:ref:`, `:mod:`, `:class:` etc. #37597

Open mkoeppe opened 3 months ago

mkoeppe commented 3 months ago

All of these should be replaced by proper references using the :ref: Sphinx role, or, for most links to the reference manual, using :mod:, :func:, :class:` etc.

When there is no label that can be linked to, create one.

$ git --no-pager grep '<[.][.]/' 
src/doc/de/tutorial/introduction.rst:   (`Dieser Link <../../en/installation/index.html>`_ sollte Sie zu
src/doc/de/tutorial/sagetex.rst:<../../en/installation/index.html>`_ sollte Sie zu einer lokalen Kopie der
src/doc/en/developer/coding_in_python.rst:  - `importlib_metadata <../reference/spkg/importlib_metadata>`_
src/doc/en/developer/coding_in_python.rst:  - `importlib_resources <../reference/spkg/importlib_resources>`_
src/doc/en/developer/coding_in_python.rst:  - `typing_extensions <../reference/spkg/typing_extensions>`_
src/doc/en/developer/packaging.rst:(according to `debugging options <../installation/source.html#sage-debug>`_
src/doc/en/developer/packaging.rst:`fat binaries <../installation/source.html#sage-fat-binary>`_).
src/doc/en/developer/portability_testing.rst:(The Sage `Installation Guide <../installation/index.html>`_ also
src/doc/en/developer/portability_testing.rst:see also `the _sagemath dummy package <../reference/spkg/_sagemath.html>`_),
src/doc/en/developer/sage_manuals.rst:   * - `Tutorial <../tutorial/index.html>`_
src/doc/en/developer/sage_manuals.rst:   * - `Developer's guide <../developer/index.html>`_
src/doc/en/developer/sage_manuals.rst:   * - `Constructions <../constructions/index.html>`_
src/doc/en/developer/sage_manuals.rst:   * - `Installation guide <../installation/index.html>`_
src/doc/en/developer/sage_manuals.rst:   * - `Reference manual <../reference/index.html>`_
src/doc/en/developer/walkthrough.rst:from source <../installation/source.html>`_ in the Sage installation guide. If
src/doc/en/developer/walkthrough.rst:<../installation/conda.html>`_.
src/doc/en/faq/faq-general.rst:`External Packages <../reference/spkg/index.html>`_
src/doc/en/faq/faq-general.rst:testing <../developer/portability_testing.html>`_ in the Developer's
src/doc/en/installation/linux.rst:See `the _sagemath dummy package <../reference/spkg/_sagemath.html>`_
src/doc/en/installation/source.rst:<../reference/spkg/index.html>`_.  Sage provides its own software
src/doc/en/installation/source.rst:  <../reference/spkg/_prereq.html>`_
src/doc/en/installation/source.rst:- `C/C++ compilers <../reference/spkg/gcc.html>`_
src/doc/en/installation/source.rst:- `Fortran compiler <../reference/spkg/gfortran.html>`_
src/doc/en/installation/source.rst:- `Python <../reference/spkg/python3.html>`_
src/doc/en/installation/source.rst:bootstrapping <../reference/spkg/_bootstrap.html>`_; they cannot be
src/doc/en/installation/source.rst:   in the reference manual <../reference/spkg/index.html#optional-packages>`_ for
src/doc/en/prep/Quickstarts/Interact.rst::doc:`programming tutorial <../Programming>`.
src/doc/en/prep/Quickstarts/Linear-Algebra.rst:<../Programming>`, so the content here continues from there to some
src/doc/en/prep/Quickstarts/Multivariable-Calculus.rst::doc:`calculus tutorial <../Calculus>`, the syntax for
src/doc/en/reference/footer.txt:* `Index <../genindex.html>`_
src/doc/en/reference/footer.txt:* `Module Index <../py-modindex.html>`_
src/doc/en/reference/footer.txt:* `Search Page <../search.html>`_
src/doc/en/reference/games/index.rst:`Rubik's Cube Group <../groups/sage/groups/perm_gps/cubegroup.html>`_).
src/doc/en/reference/hecke/index.rst:Symbols <../modsym/index.html>`_ and `Modular Forms
src/doc/en/reference/hecke/index.rst:<../modfrm/index.html>`_.
src/doc/en/reference/interfaces/index.rst:`C/C++ Library Interfaces <../libs/index.html>`_)
src/doc/en/reference/interfaces/index.rst:    `C/C++ Library Interfaces <../libs/index.html>`_
src/doc/en/reference/misc/sagetex.rst:<../../tutorial/index.html>`_ should take you to a local copy of the
src/doc/en/thematic_tutorials/index.rst:* `Introductory Sage Tutorial (PREP) <../prep/Intro-Tutorial.html>`_
src/doc/en/thematic_tutorials/index.rst:* `Sage's main tutorial <../tutorial/index.html>`_
src/doc/en/thematic_tutorials/index.rst:* `Tutorial: Sage Introductory Programming (PREP) <../prep/Programming.html>`_
src/doc/en/thematic_tutorials/index.rst:* `Tutorial: Symbolics and Plotting (PREP) <../prep/Symbolics-and-Basic-Plotting.html>`_
src/doc/en/thematic_tutorials/index.rst:* `Tutorial: Calculus (PREP) <../prep/Calculus.html>`_
src/doc/en/thematic_tutorials/index.rst:* `Tutorial: Advanced-2D Plotting (PREP) <../prep/Advanced-2DPlotting.html>`_
src/doc/en/thematic_tutorials/sandpile.rst:   <../reference/sage/graphs/graph_generators.html>`_
src/doc/en/thematic_tutorials/sws2rst.rst:  the `developer's manual <../developer/index.html>`_). However, you probably
src/doc/en/thematic_tutorials/tutorial-implementing-algebraic-structures.rst:We can look at the available `Categories <../reference/categories/sage/categories/category.html>`_ 
src/doc/en/tutorial/introduction.rst:   <../installation/index.html>`_ should take you to a local copy of the
src/doc/es/tutorial/introduction.rst:   <../../en/installation/index.html>`_ debería llevarte a tu copia
src/doc/fr/tutorial/introduction.rst:   <../../en/installation/index.html>`_ devrait pointer vers une copie
src/doc/fr/tutorial/sagetex.rst:<../../en/installation/index.html>`_ devrait conduire à une copie
src/doc/ja/tutorial/introduction.rst:   設定法については, `Sage installation guide <http://doc.sagemath.org/html/en/>`_ 中の "Make SageTeX known to TeX" を参照してほしい(ローカルシステム上の `ここ <../../en/installation/index.html>`_ にもインストールガイドがある).
src/doc/ru/tutorial/introduction.rst:   (`данная ссылка <../../en/installation/index.html>`_ ведет к локальному размещению
src/doc/ru/tutorial/sagetex.rst:<../../en/installation/index.html>`_ ведет к локальному размещению копии руководства
src/sage/categories/examples/with_realizations.py:         <../../../../../thematic_tutorials/tutorial-implementing-algebraic-structures>`_
src/sage/categories/with_realizations.py:          <../../../../../thematic_tutorials/tutorial-implementing-algebraic-structures>`_
src/sage/combinat/algebraic_combinatorics.py:- `Algebraic Combinatorics in Sage <../../../../thematic_tutorials/algebraic_combinatorics.html>`_
src/sage/combinat/algebraic_combinatorics.py:- `Lie Methods and Related Combinatorics in Sage <../../../../thematic_tutorials/lie.html>`_
src/sage/combinat/algebraic_combinatorics.py:- `Linear Programming (Mixed Integer) <../../../../thematic_tutorials/linear_programming.html>`_
src/sage/combinat/crystals/all.py:- The `Lie Methods and Related Combinatorics <../../../../../thematic_tutorials/lie.html>`_ thematic tutorial
src/sage/combinat/root_system/all.py:- The `Lie Methods and Related Combinatorics <../../../../../thematic_tutorials/lie.html>`_ thematic tutorial
src/sage/graphs/graph_plot.py:      lines to `Sage's startup scripts <../../../repl/startup.html>`_. Example::
src/sage/interacts/library.py:Sage interacts are applications of the `@interact decorator <../../sagenb/notebook/interact.html>`_.
src/sage/matrix/matrix_gfpn_dense.pyx:This module is a wrapper for the `Aachen C-MeatAxe library <../spkg/meataxe.html>`_,
src/sage/matrix/matrix_gfpn_dense.pyx:    <../spkg/meataxe.html>` package has been installed.
src/sage/modules/fp_graded/steenrod/module.py:<../../../../../../thematic_tutorials/steenrod_algebra_modules.html>`_
src/sage/modules/fp_graded/steenrod/module.py:        <../../../../../../thematic_tutorials/steenrod_algebra_modules.html>`_.
src/sage/modules/tutorial_free_modules.py:<../../../../../thematic_tutorials/tutorial-implementing-algebraic-structures>`_
src/sage/numerical/mip.pyx:    <../../../../thematic_tutorials/linear_programming.html>`_
src/sage/numerical/mip.pyx:      <../../../../thematic_tutorials/linear_programming.html#solvers-backends>`_
src/sage/rings/asymptotic/asymptotic_ring.py:`coercion <../../../../coercion/index.html>`_. For example, the coefficient ring is automatically extended when needed::
src/sage/rings/big_oh.py:    - `asymptotic expansions <../../../asymptotic/index.html>`_
src/sage/rings/big_oh.py:    - `p-adic numbers <../../../padics/index.html>`_
src/sage/rings/big_oh.py:    - `power series <../../../power_series/index.html>`_
src/sage/rings/big_oh.py:    - `polynomials <../../../polynomial_rings/index.html>`_
Nidhi-Sharma9419 commented 3 months ago

Can I work on this issue?

Nidhi-Sharma9419 commented 3 months ago

Command sage --docbuild is not working on my pc. Is there any other I can check my changes?

mkoeppe commented 3 months ago

Create a PR with your changes, then the docbuild will be run there

Nidhi-Sharma9419 commented 3 months ago

There are some links which don't work or those files don't exist , for e.g. src/doc/en/thematic_tutorials/sandpile.rst: <../reference/sage/graphs/graphgenerators.html>`

Should I leave them as it is without doing any changes?

mkoeppe commented 3 months ago

This links to the automatically generated documentation for the module sage.graphs.graph_generators. This should be replaced by use of the appropriate Sphinx role:

:mod:`sage.graphs.graph_generators`
AdwitiyaS commented 3 months ago

I've created a pull request to address this issue. You can review it here #37685