|
|
@@ -30,11 +30,11 @@ You can install the module, build the documentation or do both (advised ;P). If
|
|
|
|
|
|
Install BeeWatch
|
|
|
----------------
|
|
|
-To install BeeWatch run `./setup.py install` in BeeWatch-X.X. For more options run `./setup.py help` or see `Distributing on python.org <https://docs.python.org/3/distutils/index.html>`_
|
|
|
+To install BeeWatch run ``./setup.py install`` in BeeWatch-X.X. For more options run ``./setup.py help`` or see `Distributing on python.org <https://docs.python.org/3/distutils/index.html>`_
|
|
|
|
|
|
Build the documentation
|
|
|
-----------------------
|
|
|
-This project uses Sphinx for documentation generation. Sphinx can create the documentation in a variety of formats, eg html, pdf, epub an more. Run ``make help`` to get a list of supported file formats. Let's say you chose html, so you run ``make html``. This create the documentation in `docs/html`. The entry point is `docs/html/index.html`.
|
|
|
+This project uses Sphinx for documentation generation. Sphinx can create the documentation in a variety of formats, eg html, pdf, epub an more. Run ``make help`` to get a list of supported file formats. Let's say you chose html, so you run ``make html``. This creates the documentation in `docs/html`. The entry point for reading it is `docs/html/index.html`.
|
|
|
|
|
|
|
|
|
|
