[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
Re: [tor-bugs] #28648 [Core Tor/sbws]: Broken links in DEPLOY.rst
#28648: Broken links in DEPLOY.rst
---------------------------+-----------------------------------
Reporter: teor | Owner: (none)
Type: defect | Status: new
Priority: Medium | Milestone: sbws: 1.0.x-final
Component: Core Tor/sbws | Version:
Severity: Normal | Resolution:
Keywords: | Actual Points:
Parent ID: | Points:
Reviewer: | Sponsor:
---------------------------+-----------------------------------
Comment (by juga):
Replying to [comment:2 juga]:
[...]
> I tried to cover all the possible ways one could read the documentation
from, which are:
> 1. rst source files (no Internet, not build documentation):
`/docs/source/X.rst`
> 2. Github: interpret rst, but not Sphinx references: `<X.html>`_
> 3. rtfd and locally build documentation: interpret Sphinx references and
rst: :doc:`X`
>
> 3 is not needed and i need to fix 2
All the other sphinx directives, would be also broken when reading the
docs in Github, like :term:`scanner` (interpreted as docs/glossary.html
#term-scanner in rtfd)
If we want that the docs can be read in Github, i'd need to stop using
Sphinx directives and remove all of them.
Maybe there should be warning instead saying to look the documentation in
rtfd?.
There's the Debian package sbws-doc, which includes the html pages
generated by Sphinx, in which the directives are correctly interpreted.
--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/28648#comment:4>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online
_______________________________________________
tor-bugs mailing list
tor-bugs@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs