Skip to content

Commit 0346db6

Browse files
Update docs requirements installing
Removes redundant requirements.txt which was also present and not pinned in setup.cfg. Also updates the docs to reflect the same. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent 1106e0a commit 0346db6

File tree

2 files changed

+10
-17
lines changed

2 files changed

+10
-17
lines changed

docs/requirements.txt

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/source/contribute/contrib_doc.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,20 @@ That will create an ``/scancode-toolkit`` directory in your working directory.
1818
Now you can install the dependencies in a virtualenv::
1919

2020
cd scancode-toolkit
21-
virtualenv -p /usr/bin/python3 docs-venv
22-
source docs-venv/bin/activate
21+
./configure --dev
22+
source venv/bin/activate
2323

24-
Now, the following prerequisites are installed
24+
Now, the following prerequisites should be installed
2525

2626
- Sphinx
2727
- sphinx_rtd_theme (the format theme used by ReadTheDocs)
2828
- docs8 (style linter)
2929

3030
::
3131

32-
pip install Sphinx sphinx_rtd_theme doc8
32+
pip install -e .[docs]
33+
34+
These requirements are already present in setup.cfg and this installs them.
3335

3436
Now you can build the HTML documents locally::
3537

@@ -102,6 +104,10 @@ So run these scripts at your local system before creating a Pull Request::
102104
./scripts/sphinx_build_link_check.sh
103105
./scripts/doc8_style_check.sh
104106

107+
If you don't have permission to run the scripts, run::
108+
109+
chmod u+x ./scripts/doc8_style_check.sh
110+
105111
.. _doc_style_docs8:
106112

107113
Style Checks Using ``Doc8``

0 commit comments

Comments
 (0)