[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 [ticket:28648 teor]:
> These links are broken on GitHub:
>
> {{{
> To configure destinations, create a configuration file according to
./docs/source/man_sbws.ini.rst (or /docs/source/man_sbws.ini.rst or
:doc:`man_sbws.ini` or man sbws.ini)
> }}}
>
> https://github.com/torproject/sbws/blob/master/DEPLOY.rst#scanner-setup
You get this URL from :doc:`man_sbws.ini` in Github, because it's a Sphinx
directive.
It's correctly interpreted in
https://sbws.readthedocs.io/en/latest/DEPLOY.html or when you build the
documentation locally and open it in a browser as
file:///.../sbws/docs/build/html/DEPLOY.html
The link `/docs/source/man_sbws.rst <man_sbws>`_ is wrong, it should be
`<man_sbws.html>`_ and this would work both in Githab and rtfd.
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
--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/28648#comment:2>
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