Skip to content

Commit 75ed4dd

Browse files
authored
docs: Clarify documentation location and online access
Updated documentation section to clarify online access and local structure.
1 parent f23bc04 commit 75ed4dd

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,9 @@ To run all the tests the only thing you need to do is run::
5757
Documentation
5858
=============
5959

60-
We maintain documentation under the ``docs`` folder using rst format.
60+
The documentation is online on `readthedocs <https://djangocms-versioning.readthedocs.io>`_.
61+
62+
We maintain documentation in this repository under the ``docs`` folder using rst format.
6163

6264
To generate the HTML documentation you will need to install ``sphinx`` (``pip install sphinx``) and ``graphviz`` (as per your operating system's package management system). You can then generate the docs using the following command:
6365

@@ -112,4 +114,4 @@ do not forget to run the ``compilemessages`` management command.
112114

113115
.. |CmsVersion| image:: https://img.shields.io/pypi/frameworkversions/django-cms/djangocms-versioning.svg?style=flat-square
114116
:target: https://pypi.python.org/pypi/djangocms-versioning
115-
:alt: django CMS versions
117+
:alt: django CMS versions

0 commit comments

Comments
 (0)