Skip to content
This repository was archived by the owner on Aug 25, 2024. It is now read-only.

Commit 5412608

Browse files
committed
docs: contributing: git: Update DOCS possible errors
Signed-off-by: John Andersen <[email protected]>
1 parent 900b6df commit 5412608

File tree

3 files changed

+9
-2
lines changed

3 files changed

+9
-2
lines changed

docs/contributing/dev_env.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,11 @@ For example, to install the TensorFlow models
7272
7373
$ python3.7 -m pip install --prefix=~/.local -e model/tensorflow
7474
75+
.. _dev_env_install_official_plugins:
76+
77+
Installing Plugins In Development Mode
78+
--------------------------------------
79+
7580
To install all the plugins in development mode use the development service's
7681
install command.
7782

docs/contributing/docs.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
Documentation
22
=============
33

4+
You'll want to have all of the official plugins installed when generating the
5+
documentation. See :ref:`dev_env_install_official_plugins`.
6+
47
To build, run the docs script.
58

69
.. code-block:: console

docs/contributing/git.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,7 @@ is okay.
122122
+--------------+---------------------------------------------------------------+
123123
| STYLE | You need to run the ``black`` formater |
124124
+--------------+---------------------------------------------------------------+
125-
| DOCS | You changed a docstring for something and didn't run |
126-
| | ./scripts/docs.sh before commiting and pushing |
125+
| DOCS | There was an issue when running the ./scripts/docs.sh script |
127126
+--------------+---------------------------------------------------------------+
128127

129128
For the tests in the various plugins:

0 commit comments

Comments
 (0)