Skip to content

Commit 417e879

Browse files
committed
Merge pull request #205 from pkuczynski/docs-contributing-docs
Docs: some more info how to contribute to the documentation
2 parents 7aec844 + b8acfed commit 417e879

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/contributing/index.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,20 +65,26 @@ Do not include any changes to the ``dist/`` folder or bump version numbers yours
6565
Documentation
6666
-------------
6767

68-
The documentation is written using `reStructuredText <http://en.wikipedia.org/wiki/ReStructuredText>`_, and compiled using `Sphinx <http://sphinx-doc.org/>`_
68+
The documentation is written using `reStructuredText <http://en.wikipedia.org/wiki/ReStructuredText>`_, and compiled using `Sphinx <http://sphinx-doc.org/>`_. If you don't have Sphinx installed, you can do it using following command (assuming you have Python already installed in your system):
6969

70-
Documentation can be compiled by running:
70+
.. code-block:: sh
71+
72+
$ pip install sphinx
73+
74+
Documentation can be then compiled by running:
7175

7276
.. code-block:: sh
7377
7478
$ make docs
7579
76-
Then viewing in your browser with:
80+
Afterwards you can view it in your browser by running following command and than pointing your browser to http://127.0.0.1:8000/:
7781

7882
.. code-block:: sh
7983
8084
$ grunt run:docs
8185
86+
87+
8288
Releasing New Version
8389
~~~~~~~~~~~~~~~~~~~~~
8490

0 commit comments

Comments
 (0)