Skip to content

Commit

Permalink
DOCS-#2419: Updated CONTRIBUTING.rst (#2423)
Browse files Browse the repository at this point in the history
Signed-off-by: Victor Fomin <vfdev.5@gmail.com>
  • Loading branch information
vfdev-5 committed Nov 14, 2020
1 parent 140988e commit 5252282
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,26 @@ subset of the test suite. In order to run a specific test run:
The entire test suite is automatically run for each pull request.

Building documentation
----------------------

To build the documentation, please follow the steps below from the project root:

.. code-block:: bash
cd docs
pip install -r requirements-doc.txt
sphinx-build -b html . build
To visualize the documentation locally, run the following from `build` folder:

.. code-block:: bash
python -m http.server <port>
# python -m http.server 1234
then open the browser at `0.0.0.0:<port>` (e.g. `0.0.0.0:1234`).

Contributing a new execution framework or in-memory format
----------------------------------------------------------

Expand Down

0 comments on commit 5252282

Please sign in to comment.