Opened 5 years ago

Closed 5 years ago

#22931 closed enhancement (fixed)

Add missing sphinx labels to prep and other tutorials

Reported by: nthiery Owned by:
Priority: major Milestone: sage-8.0
Component: documentation Keywords:
Cc: Merged in:
Authors: Nicolas M. Thiéry Reviewers: John Palmieri
Report Upstream: N/A Work issues:
Branch: 5840844 (Commits, GitHub, GitLab) Commit: 58408447206956771a85f92e0b73d89dbd1041e6
Dependencies: Stopgaps:

Status badges

Description (last modified by nthiery)

This will enable crosslinking them from other reST+Sphinx documents, inside and outside Sage's documentation, including https://readthedocs.org/projects/more-sagemath-thematic-tutorials/

Questions:

  • prefix labels with their document? E.g. prep-programming rather than programming
  • Change the title of the ref manual to "Reference Manual" rather than "Content" to get a nicer title in cross-references?
  • Can we link from the thematic tutorials to the prep tutorials?

Change History (14)

comment:1 Changed 5 years ago by nthiery

  • Description modified (diff)
  • Summary changed from Add missinng labels to prep and other tutorials to Add missing sphinx labels to prep and other tutorials

comment:2 Changed 5 years ago by nthiery

  • Branch set to u/nthiery/add_missing_sphinx_labels_to_prep_and_other_tutorials

comment:3 Changed 5 years ago by nthiery

  • Commit set to f9291c573de501553996af6845e098bad0f5cfdf
  • Description modified (diff)

New commits:

f9291c522931: added missing Sphinx labels to prep tutorials

comment:4 Changed 5 years ago by git

  • Commit changed from f9291c573de501553996af6845e098bad0f5cfdf to ba996ea23e0f49240c938fd1fe2944e66f0c2575

Branch pushed to git repo; I updated commit sha1. New commits:

ba996ea22931: add Sphinx labels to the root of all documents

comment:5 Changed 5 years ago by nthiery

  • Status changed from new to needs_review

comment:6 in reply to: ↑ description ; follow-up: Changed 5 years ago by jhpalmieri

My opinions:

Replying to nthiery:

Questions:

  • prefix labels with their document? E.g. prep-programming rather than programming

Sure, sounds good.

  • Change the title of the ref manual to "Reference Manual" rather than "Content" to get a nicer title in cross-references?

Yes.

  • Can we link from the thematic tutorials to the prep tutorials?

If we can, we should.

In addition to the changes here, it would be nice to see some crosslinkings among the documents, if for no other reason than to illustrate how they work.

comment:7 Changed 5 years ago by git

  • Commit changed from ba996ea23e0f49240c938fd1fe2944e66f0c2575 to 643e829eb731c754ae5f67e0772125b204a82615

Branch pushed to git repo; I updated commit sha1. New commits:

643e82922931: normalize the new labels for the prep documents with a prep- prefix.

comment:8 Changed 5 years ago by git

  • Commit changed from 643e829eb731c754ae5f67e0772125b204a82615 to ab7ca3ff21168dd65d06c81d1cf983d502df5a67

Branch pushed to git repo; I updated commit sha1. New commits:

ab7ca3f22931: Changed title (and intro) for the reference manual for consistency with the other documents

comment:9 Changed 5 years ago by git

  • Commit changed from ab7ca3ff21168dd65d06c81d1cf983d502df5a67 to 58408447206956771a85f92e0b73d89dbd1041e6

Branch pushed to git repo; I updated commit sha1. New commits:

30610b422931: Changed title (and intro) for the reference manual for consistency with the other documents (cont'd)
584084422931: added one crossref for illustration purposes

comment:10 in reply to: ↑ 6 Changed 5 years ago by nthiery

Replying to jhpalmieri:

Sure, sounds good. Yes.

Done.

If we can, we should.

Agreed. Digging a bit more in, I believe we can't at this stage. Too bad.

In addition to the changes here, it would be nice to see some crosslinkings among the documents, if for no other reason than to illustrate how they work.

I added one for illustration purpose. Adding many would be very nice indeed, but I'd say it's for a (or several) follow-up ticket(s).

Thanks John for looking at this!

comment:11 Changed 5 years ago by jhpalmieri

  • Reviewers set to John Palmieri
  • Status changed from needs_review to positive_review

This looks good to me.

comment:12 Changed 5 years ago by nthiery

Thank you John for the review!

comment:13 Changed 5 years ago by nthiery

For the record: I had a look at the failing test reported by the patchbot, and it seems very much unrelated (in cmdline).

comment:14 Changed 5 years ago by vbraun

  • Branch changed from u/nthiery/add_missing_sphinx_labels_to_prep_and_other_tutorials to 58408447206956771a85f92e0b73d89dbd1041e6
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.