Opened 6 years ago

Last modified 6 years ago

#17634 closed enhancement

Rephrase the 'sage manuals' section of the developer manual — at Version 9

Reported by: ncohen Owned by:
Priority: major Milestone: sage-6.5
Component: documentation Keywords:
Cc: kcrisman, jhpalmieri, vdelecroix, tmonteil Merged in:
Authors: Nathann Cohen Reviewers:
Report Upstream: N/A Work issues:
Branch: public/17634 (Commits, GitHub, GitLab) Commit: 95e886497f4b07fb5f3a795cca4ca5998377c47d
Dependencies: Stopgaps:

Status badges

Description (last modified by ncohen)

As for the previous tickets, this branch is meant to make it easier to browse through. Shorter sentences, links, bold text.

This branch also moves (without changing anything) the tutorial on 'How to turn a sws file into a rst file' as it is not about Sage's internal documentation nor about Sage development.

I also fixed the documentation about 'how to add a file to the doc', as the example used the combinat/ folder which since #16256 has a different procedure for that.

Change History (9)

comment:1 Changed 6 years ago by ncohen

  • Branch set to public/17634
  • Status changed from new to needs_review

comment:2 Changed 6 years ago by git

  • Commit set to adffa81b264ca4414d96e6f2d4bcc51b7e003c34

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

df6a516trac #17634: Rephrase the 'sage manuals' section of the developer manual
adffa81trac #17634: Move the sws2rst tutorial to the thematic tutorials

comment:3 Changed 6 years ago by ncohen

  • Description modified (diff)

comment:4 follow-up: Changed 6 years ago by kcrisman

I've been away from computer all day and don't have time to look at this in detail, but if you really think that moving the sws2rst thing out is a good idea, there had better be a link to wherever you move it to in the developer guide. The reason that document even exists is because someone wanted to contribute to the thematic tutorials (hence, to be a developer!) and couldn't figure out how to do it without writing her own document to explain it. So it was clearly valuable in the developer sense, turning things not just into rst files but into contributed documentation. Does that explain it sufficiently? Sorry if it's confusing because of my hurry.

comment:5 Changed 6 years ago by git

  • Commit changed from adffa81b264ca4414d96e6f2d4bcc51b7e003c34 to 95e886497f4b07fb5f3a795cca4ca5998377c47d

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

95e8864trac #17634: Review

comment:6 in reply to: ↑ 4 Changed 6 years ago by ncohen

Hello Karl-Dieter,

Does that work for you? I tried to add it at a place where those who are interested are sure to see it, while making it not too intrusive. It ends up being the first thing that everybody will read ;-)

Nathann

comment:7 Changed 6 years ago by kcrisman

I'm really sorry I don't have time to think about this properly. Maybe it's a little too early there :-) but my bigger worry is whether that link will be brittle.

comment:8 Changed 6 years ago by ncohen

I'm sorry Karl, I don't know how to make it better.

Nathann

comment:9 Changed 6 years ago by ncohen

  • Description modified (diff)
Note: See TracTickets for help on using tickets.