Changeset - 61bd04b90f58
[Not reviewed]
default
0 4 0
Mads Kiilerich (mads) - 6 years ago 2020-08-01 22:28:19
mads@kiilerich.com
Grafted from: d9d1aedbbdd0
docs: clean up readthedocs URLs

It will redirect to the canonical URL https://*.readthedocs.io/en/latest , and
there is no point in linking to /en/latest .
4 files changed with 7 insertions and 7 deletions:
0 comments (0 inline, 0 general)
docs/overview.rst
Show inline comments
 
@@ -211,26 +211,26 @@ continuous hammering from the internet.
 
.. note::
 
   Kallithea, the libraries it uses, and Python itself do in several places use
 
   simple caching in memory. Caches and memory are not always released in a way
 
   that is suitable for long-running processes. They might appear to be leaking
 
   memory. The worker processes should thus regularly be restarted - for
 
   example after 1000 requests and/or one hour. This can usually be done by the
 
   web server or the tool used for running it as a system service.
 

	
 

	
 
.. _Python: http://www.python.org/
 
.. _Gunicorn: http://gunicorn.org/
 
.. _Gevent: http://www.gevent.org/
 
.. _Waitress: http://waitress.readthedocs.org/en/latest/
 
.. _Gearbox: http://turbogears.readthedocs.io/en/latest/turbogears/gearbox.html
 
.. _Waitress: https://docs.pylonsproject.org/projects/waitress/
 
.. _Gearbox: https://turbogears.readthedocs.io/en/latest/turbogears/gearbox.html
 
.. _PyPI: https://pypi.python.org/pypi
 
.. _Apache httpd: http://httpd.apache.org/
 
.. _mod_wsgi: https://code.google.com/p/modwsgi/
 
.. _isapi-wsgi: https://github.com/hexdump42/isapi-wsgi
 
.. _uWSGI: https://uwsgi-docs.readthedocs.org/en/latest/
 
.. _uWSGI: https://uwsgi-docs.readthedocs.io/
 
.. _nginx: http://nginx.org/en/
 
.. _iis: http://en.wikipedia.org/wiki/Internet_Information_Services
 
.. _pip: http://en.wikipedia.org/wiki/Pip_%28package_manager%29
 
.. _WSGI: http://en.wikipedia.org/wiki/Web_Server_Gateway_Interface
 
.. _HAProxy: http://www.haproxy.org/
 
.. _Varnish: https://www.varnish-cache.org/
 
.. _npm: https://www.npmjs.com/
docs/setup.rst
Show inline comments
 
@@ -223,25 +223,25 @@ be writeable by the Kallithea user.
 
The ``authorized_keys`` file can be updated manually with ``kallithea-cli
 
ssh-update-authorized-keys -c my.ini``. This command is not needed in normal
 
operation but is for example useful after changing SSH-related settings in the
 
``.ini`` file or renaming that file. (The path to the ``.ini`` file is used in
 
the generated ``authorized_keys`` file).
 

	
 

	
 
Setting up Whoosh full text search
 
----------------------------------
 

	
 
Kallithea provides full text search of repositories using `Whoosh`__.
 

	
 
.. __: https://whoosh.readthedocs.io/en/latest/
 
.. __: https://whoosh.readthedocs.io/
 

	
 
For an incremental index build, run::
 

	
 
    kallithea-cli index-create -c my.ini
 

	
 
For a full index rebuild, run::
 

	
 
    kallithea-cli index-create -c my.ini --full
 

	
 
The ``--repo-location`` option allows the location of the repositories to be overridden;
 
usually, the location is retrieved from the Kallithea database.
 

	
docs/usage/email.rst
Show inline comments
 
@@ -80,17 +80,17 @@ configuration file -- an email with exce
 
to the addresses specified in ``email_to`` in the configuration file.
 

	
 
Recipients will see these emails originating from the sender specified in the
 
``error_email_from`` setting in the configuration file. This setting can either
 
contain only an email address, like `kallithea-noreply@example.com`, or both
 
a name and an address in the following format: `Kallithea Errors
 
<kallithea-noreply@example.com>`.
 

	
 

	
 
References
 
----------
 

	
 
- `Error Middleware (Pylons documentation) <http://pylons-webframework.readthedocs.org/en/latest/debugging.html#error-middleware>`_
 
- `ErrorHandler (Pylons modules documentation) <http://pylons-webframework.readthedocs.org/en/latest/modules/middleware.html#pylons.middleware.ErrorHandler>`_
 
- `Error Middleware (Pylons documentation) <https://pylons-webframework.readthedocs.io/en/latest/debugging.html#error-middleware>`_
 
- `ErrorHandler (Pylons modules documentation) <https://pylons-webframework.readthedocs.io/en/latest/modules/middleware.html#pylons.middleware.ErrorHandler>`_
 

	
 

	
 
.. _backlash: https://github.com/TurboGears/backlash
scripts/make-release
Show inline comments
 
@@ -66,16 +66,16 @@ EOT
 

	
 
echo "Verify current revision is tagged for $version"
 
hg log -r "'$version'&." | grep .
 

	
 
echo -n "Enter \"pypi\" to upload Kallithea $version to pypi: "
 
read answer
 
[ "$answer" = "pypi" ]
 

	
 
echo "Rebuild readthedocs for docs.kallithea-scm.org"
 
xdg-open https://readthedocs.org/projects/kallithea/
 
curl -X POST http://readthedocs.org/build/kallithea
 
xdg-open https://readthedocs.org/projects/kallithea/builds
 
xdg-open http://docs.kallithea-scm.org/en/latest/ # or whatever the branch is
 
xdg-open https://docs.kallithea-scm.org/en/latest/ # or whatever the branch is
 

	
 
twine upload dist/*
 
xdg-open https://pypi.python.org/pypi/Kallithea
0 comments (0 inline, 0 general)