commit 95d6c68f0031569d8e1b3f86f7a6553f6235e5e9 Author: juga0 <juga@riseup.net> Date: Fri Nov 30 13:52:01 2018 +0000 docs: Change links to be interpreted by ReST or Markdown. Also change links to be interpreted by GitHub and remove Sphinx directives in the main documentation pages. Closes #28648. --- DEPLOY.rst | 13 +++++++------ INSTALL.rst | 3 ++- README.md | 19 +++++++++++-------- 3 files changed, 20 insertions(+), 15 deletions(-) diff --git a/DEPLOY.rst b/DEPLOY.rst index 6789db4..afbdc5f 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -25,12 +25,13 @@ destination requirements scanner setup ---------------------- -Install sbws according to ``./INSTALL.rst`` (or `/INSTALL.rst </INSTALL.rst>`_ -or :ref:`install`). +Install sbws according to `<INSTALL.rst>`_ (in the local directory or GitHub) +or `<INSTALL.html>`_ (local build or Read the Docs). To configure destinations, create a configuration file according to -``./docs/source/man_sbws.ini.rst`` (or `/docs/source/man_sbws.ini.rst <man_sbws.ini>`_ -or :doc:`man_sbws.ini` or ``man sbws.ini``) +``./docs/source/man_sbws.ini.rst`` (in the local directory or GitHub) or +`<man_sbws.ini.html>`_ (local build or Read the Docs) or +``man sbws.ini`` (Debian). -See also ``./docs/source/man_sbws.rst`` (or `/docs/source/man_sbws.rst <man_sbws>`_ or -:doc:`man_sbws` or ``man sbws``) manual page. +See also ``./docs/source/man_sbws.rst`` (in the local directory or GitHub) or +`<man_sbws.html>`_ (local build or Read the Docs) or ``man sbws`` (Debian). diff --git a/INSTALL.rst b/INSTALL.rst index fc2ec7c..416285c 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -51,7 +51,8 @@ Install the python dependencies:: ``sbws`` needs :term:`destination` s to request files from. -Please, see ./DEPLOY.rst (or `/DEPLOY.rst </DEPLOY.rst>`_ or :ref:`deploy`) +Please, see `<DEPLOY.rst>`_ (in the local directory or GitHub) or +`<DEPLOY.html>`_ (local build or Read the Docs) to configure, deploy and run ``sbws``. System physical requirements diff --git a/README.md b/README.md index b001943..65a7d03 100644 --- a/README.md +++ b/README.md @@ -29,29 +29,31 @@ It can also be read after installing the Debian package ``sbws-doc`` in Installing ------------ -See ./INSTALL.rst (or [INSTALL](./INSTALL.rst) or [INSTALL](./INSTALL.html) ) +See [./INSTALL.rst](INSTALL.rst) (in local directory or GitHub) or +[INSTALL.html](INSTALL.html) (local build or Read the Docs). Deploying and running --------------------- -See ./DEPLOY.rst (or [DEPLOY](./DEPLOY.rst) or [DEPLOY](./DEPLOY.html) ) +See [./DEPLOY.rst](DEPLOY.rst) (in local directory or GitHub) or +[DEPLOY.html](DEPLOY.html) (local build or Read the Docs). Contributing -------------- -See ./CONTRIBUTING.rst (or [CONTRIBUTING](./CONTRIBUTING.rst) or -[CONTRIBUTING](./CONTRIBUTING.html) ) +See [./CONTRIBUTING.rst](CONTRIBUTING.rst) (in local directory or GitHub) or +[CONTRIBUTING.html](CONTRIBUTING.html) (local build or Read the Docs). Changelog -------------- -See ./CHANGELOG.rst (or [CHANGELOG](./CHANGELOG.rst) or -[CHANGELOG](./CHANGELOG.html) ) +See [./CHANGELOG.rst](CHANGELOG.rst) (in local directory or GitHub) or +[CHANGELOG.html](CHANGELOG.html) (local build or Read the Docs). Documentation -------------- -More extensive documentation can be found in the ./docs directory, +More extensive documentation can be found in the ``./docs`` directory, and online at [sbws.rtfd.io](https://sbws.readthedocs.io) and [this onion service](http://d7pxflytfsmz6uh3x7i2jxzzwea6nbpmtsz5tmfkcin5edapaig5vpyd.onion/) ([v2](http://sdmb3rfvp3wadu6y.onion/)). @@ -68,4 +70,5 @@ software in ./LICENSE.md ## Authors -See ./AUTHORS.md (or [AUTHORS](./AUTHORS.MD) \ No newline at end of file +See [./AUTHORS.md](AUTHORS.md) (in local directory or GitHub) or +[AUTHORS.html](AUTHORS.html) (local build or Read the Docs). \ No newline at end of file