Code Review
/
docs.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Updated git submodules
[docs.git]
/
docs
/
documentation.rst
diff --git
a/docs/documentation.rst
b/docs/documentation.rst
index 98761be04d4e25fa776da2e75c89b76cb1724535..11fdc3265d2108f12707fa43df23bcf26b5fbad2 100644
(file)
--- a/
docs/documentation.rst
+++ b/
docs/documentation.rst
@@
-17,9
+17,7
@@
reStructuredText-based Documentation
====================================
When using reStructuredText, we try to follow the python documentation
====================================
When using reStructuredText, we try to follow the python documentation
-style guide. See:
-
- https://docs.python.org/devguide/documenting.html
+style guide. See: https://docs.python.org/devguide/documenting.html
To build and review the reStructuredText documentation locally you must
have installed locally:
To build and review the reStructuredText documentation locally you must
have installed locally:
@@
-35,6
+33,7
@@
browser as follows:
.. code-block:: bash
git clone https://git.opendaylight.org/gerrit/docs
.. code-block:: bash
git clone https://git.opendaylight.org/gerrit/docs
+ cd docs
git submodule update --init
tox -edocs
firefox docs/_build/html/index.html
git submodule update --init
tox -edocs
firefox docs/_build/html/index.html