Opened 9 months ago

Last modified 3 weeks ago

#33756 new enhancement

extlinks for Sage source files

Reported by: mkoeppe Owned by:
Priority: major Milestone: sage-9.9
Component: documentation Keywords:
Cc: klee Merged in:
Authors: Matthias Koeppe Reviewers:
Report Upstream: N/A Work issues:
Branch: u/mkoeppe/extlinks_for_sage_source_files (Commits, GitHub, GitLab) Commit: 439145ee58de52edcaa43f06771cc9647a89b0e8
Dependencies: Stopgaps:

Status badges

Description (last modified by mkoeppe)

The documentation refers to various source files: 

$ git grep -E "SAGE_ROOT/(build|src|pkgs)" src/doc
...
src/doc/en/developer/doctesting.rst:  * ``SAGE_ROOT/src/doc/en``
src/doc/en/developer/doctesting.rst:  * ``SAGE_ROOT/src/doc/fr``
src/doc/en/developer/packaging.rst:available packages are the subdirectories of ``SAGE_ROOT/build/pkgs/``.
src/doc/en/developer/packaging.rst:``SAGE_ROOT/build/bin/sage-spkg``. This script is typically invoked by
src/doc/en/developer/packaging.rst:of each individual package in ``SAGE_ROOT/build/pkgs``. In section
...

We create a new extlink format for it in src/sage/misc/sagedoc.py, 

:sage_root:`src/doc/en`

which creates links to the corresponding file in ​https://github.com/sagemath/sage

Change History (5)

comment:1 Changed 9 months ago by mkoeppe

Description: modified (diff)

comment:2 Changed 9 months ago by mkoeppe

Branch: → u/mkoeppe/extlinks_for_sage_source_files

comment:3 Changed 9 months ago by mkoeppe

Authors: → Matthias Koeppe
Commit: → 439145ee58de52edcaa43f06771cc9647a89b0e8
Milestone: sage-9.6 → sage-9.7

New commits:

​3bcca8csrc/sage/misc/sagedoc.py: Add sage_root to extlinks
​439145egit grep -l -E "SAGE_ROOT/[^lu]" src/doc | xargs sed -i.bak 's,``SAGE_ROOT/\([^`]*\)``,:sage_root:`\1`,g'

comment:4 Changed 5 months ago by mkoeppe

Milestone: sage-9.7 → sage-9.8

comment:5 Changed 3 weeks ago by mkoeppe

Milestone: sage-9.8 → sage-9.9
Note: See TracTickets for help on using tickets.