Skip to content

Added documentation for using a pip requirements file. #3636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 206 commits into from
Closed
Changes from 1 commit
Commits
Show all changes
206 commits
Select commit Hold shift + click to select a range
9130f38
check for matching alias before subproject slug
funkyHat Apr 10, 2017
e07be83
Merge remote-tracking branch 'origin/master' into subproject_check_al…
funkyHat Jun 29, 2017
c3d2ddc
Address PR comments
funkyHat Oct 26, 2017
d2d4a1e
Improve "Sharing" docs
humitos Jan 4, 2018
a4bb8e3
use get_object_or_404 shortcut
funkyHat Jan 12, 2018
9bb0f28
revert style changes (where did they even come from?)
funkyHat Jan 18, 2018
6a66934
Merge remote-tracking branch 'origin/master' into subproject_check_al…
funkyHat Jan 18, 2018
828ec8a
fixed formatting buttons in edit project text editor
aasis21 Feb 18, 2018
9938805
Added documentation for using a pip requirements file
kchawla-pi Feb 18, 2018
70f5625
Fixed issues pointed out in first pull request review
kchawla-pi Feb 19, 2018
648e6fd
Fix SVN initialization for command logging (#3638)
humitos Feb 19, 2018
235c8b6
Added label for `Can I document ... root of my repository`
kchawla-pi Feb 19, 2018
d05bd73
Added `Using pip requirments file with a YAML config file
kchawla-pi Feb 19, 2018
7d793e4
Fixed label `faq_document_package_not_at_root`
kchawla-pi Feb 19, 2018
46d543a
Update RTD security docs
davidfischer Feb 19, 2018
56c8f4c
Fix a 500 when searching for files with API v1
davidfischer Feb 20, 2018
d7c779a
Changed section header underlines
kchawla-pi Feb 21, 2018
53b87a4
Added :maxdepth: 1
kchawla-pi Feb 21, 2018
8aa1da2
Fixed: Headings and body text, typos
kchawla-pi Feb 21, 2018
70cc65d
Added clarification + language & punctuation tweaks
kchawla-pi Feb 21, 2018
4bc7671
Removed redundant/verbose text from first section
kchawla-pi Feb 21, 2018
f662ce8
Added section for using conda environment.yml
kchawla-pi Feb 21, 2018
30f1291
Fixed :doc: referrer to conda.rst
kchawla-pi Feb 21, 2018
4423781
Fixed minor typo and formatting
kchawla-pi Feb 21, 2018
382c593
Merge pull request #3645 from davidfischer/fix-file-search-apiv1
ericholscher Feb 21, 2018
a129799
Add a sustainability API from non-OSS code
davidfischer Feb 21, 2018
ae6b6b5
Update the PGP key
davidfischer Feb 21, 2018
6317e06
Merge pull request #3641 from davidfischer/update-security-docs
ericholscher Feb 22, 2018
31db082
Remove error logging that isn't an error.
ericholscher Feb 22, 2018
c5753a5
Ability to override the creation of the Celery App (#3623)
humitos Feb 22, 2018
1b58bed
Send proper context to celery email notification task (#3653)
humitos Feb 22, 2018
e9d0d2f
Tests for build notifications (#3654)
humitos Feb 22, 2018
5e46cbd
Release 2.2.0
agjohnson Feb 22, 2018
0a4a287
Merge pull request #3650 from rtfd/remove-error-logs
ericholscher Feb 23, 2018
72e5f38
Fix issue with missing setting in oauth SyncRepo task (#3656)
agjohnson Feb 23, 2018
a9239fd
Upgrade django-pagination to a "maintained" fork
humitos Feb 23, 2018
43667a0
Hotfix for adding logging call back into project sync task (#3657)
agjohnson Feb 23, 2018
0e1112f
Bug fix release 2.2.1
agjohnson Feb 23, 2018
17be1c1
Show the project slug in the project admin (to make it more explicit …
ericholscher Feb 26, 2018
2950fda
removed rich text editor and its related markitup media files
aasis21 Feb 26, 2018
354ab83
Merge pull request #3681 from rtfd/project-slug-admin
davidfischer Feb 26, 2018
e7dbb2b
Check for submodules (#3661)
stsewd Feb 27, 2018
09f8282
Upgrade django-taggit to 0.22.2 (#3667)
humitos Feb 27, 2018
1330fd3
revert back description field removal and added suggested changes
aasis21 Feb 27, 2018
2e38321
Simplified the documentation siginificantly
kchawla-pi Feb 27, 2018
75511f5
Fixed yaml code block formatting
kchawla-pi Feb 27, 2018
40b2039
Add tests for translations
stsewd Feb 28, 2018
3332b6d
Add test for more than one owner
stsewd Feb 28, 2018
8afa88a
Add test for TranslationForm
stsewd Feb 28, 2018
4a7cd3e
Fix tests
stsewd Feb 28, 2018
4f77d9f
Set project as ChoiceField
stsewd Feb 28, 2018
9d1246f
Pass user to form
stsewd Feb 28, 2018
0206825
Set initial values to tests
stsewd Feb 28, 2018
7776b31
Validate by project id
stsewd Feb 28, 2018
666bf42
Validate for existen translations
stsewd Feb 28, 2018
f4acc80
Set main language to None explicitly
stsewd Feb 28, 2018
2866ab0
Filter projects that don't have translations
stsewd Feb 28, 2018
c37dff0
Fix message
stsewd Feb 28, 2018
1e5657d
Add tests for circular dependencies
stsewd Feb 28, 2018
bd68928
Check for circular translations
stsewd Feb 28, 2018
640960a
Improve template
stsewd Feb 28, 2018
5814aef
Changes on the template
stsewd Feb 28, 2018
16f3527
Remove useless js
stsewd Feb 28, 2018
8d6efef
Better error messages
stsewd Feb 28, 2018
062bff6
Use project slug as identifier
stsewd Feb 28, 2018
e527b35
Update tests
stsewd Feb 28, 2018
775b19f
Use fixure users
stsewd Feb 28, 2018
ffd60da
Check for error message
stsewd Feb 28, 2018
62a261d
Refactor tests
stsewd Feb 28, 2018
c7b5638
Use same test
stsewd Feb 28, 2018
28cc7b6
Check error messages
stsewd Feb 28, 2018
68a056c
Fix error messages
stsewd Feb 28, 2018
457ac62
Fixed #3701: added closing tag for div element
ajatprabha Feb 28, 2018
29674ee
Parent project can't already be a translation
davidfischer Mar 1, 2018
5d54966
Show lang on choices
stsewd Mar 1, 2018
b277d9b
Better error messages
stsewd Mar 1, 2018
5d3d153
Better help text
stsewd Mar 1, 2018
66419d2
Fix grammar
stsewd Mar 1, 2018
84ec88f
Remove p tag
stsewd Mar 1, 2018
308879a
Merge pull request #3633 from aasis21/fix-broken-text-editor
ericholscher Mar 1, 2018
27d9ba3
Merge pull request #3702 from ajatprabha/ticket_3701
ericholscher Mar 1, 2018
902f63f
Much clearer query
davidfischer Mar 1, 2018
2c653e2
Merge branch 'fix-bug-translations' into parent-cant-be-translation
davidfischer Mar 1, 2018
d0a2402
Use named formatting
stsewd Mar 1, 2018
4aef502
Use assertContains
stsewd Mar 1, 2018
4b00f3f
Add argument to skip errorlist through knockout on common form (#3704)
agjohnson Mar 2, 2018
94339b8
Attempt to prevent bots indexing promos
davidfischer Mar 2, 2018
c8df83f
Merge pull request #2 from readthedocs/parent-cant-be-translation
stsewd Mar 2, 2018
dc7c295
Changes to inject promos via the new API
davidfischer Mar 3, 2018
fcde821
add lint rules and fix errors
bansalnitish Mar 3, 2018
e4cb814
Refactor and simplify doc embed CSS
davidfischer Mar 4, 2018
70d94c9
Add Existing Translations header
stsewd Mar 5, 2018
d4d3170
Merge branch 'fix-bug-translations' of github.com:readthedocs/readthe…
stsewd Mar 5, 2018
333e96a
Refactor tests
stsewd Mar 5, 2018
fd6e385
Use kwarg
stsewd Mar 5, 2018
ac1ca00
Allow to delete already created translations
stsewd Mar 5, 2018
2d9aa53
Add tests
stsewd Mar 5, 2018
230ec2b
Add more ignores
agjohnson Mar 5, 2018
4030334
Do not refresh from db & check for 404
stsewd Mar 6, 2018
e25acfa
Fix tests for Git submodule (#3737)
agjohnson Mar 6, 2018
4595830
Test for delete translations with different parent
stsewd Mar 6, 2018
4e3f9bd
Merge branch 'master' of github.com:rtfd/readthedocs.org into humitos…
humitos Mar 6, 2018
78b5781
Merge pull request #3719 from davidfischer/davidfischer/bot-promo-clicks
ericholscher Mar 6, 2018
f4b9727
Merge branch 'master' into use-sustainability-api
davidfischer Mar 7, 2018
1334c3c
Check in the latest built JS
davidfischer Mar 7, 2018
3ddc15e
Force a specific campaign or promo var change
davidfischer Mar 7, 2018
d127ea5
Merge pull request #2787 from funkyHat/subproject_check_alias_before_…
ericholscher Mar 7, 2018
2a7a113
Log in the proper place and add the image name used (#3750)
humitos Mar 7, 2018
4d4b128
Replace copy "Go Crazy" with "Search" (#3752)
irkartik Mar 7, 2018
5d1d8f0
Remove pixel which isn't used
davidfischer Mar 7, 2018
e923c0c
Merge pull request #3726 from bansalnitish/lint-fix
davidfischer Mar 8, 2018
3a67d11
Merge branch 'master' into use-sustainability-api
davidfischer Mar 8, 2018
b4ed4df
Fix indentation in docs/faq.rst
berkerpeksag Mar 9, 2018
baa6b07
Check for http protocol before urlize (#3755)
stsewd Mar 9, 2018
d0c6abb
Changed 'Submit' text on buttons with something more meaningful (#3749)
shubham76 Mar 9, 2018
8b0350f
Add filtering of project repos by user owned projects (#3548)
humitos Mar 9, 2018
1edd47a
Always record the git branch command as success (#3693)
humitos Mar 9, 2018
cc18a75
Project updated when subproject modified (#3649)
humitos Mar 9, 2018
761a2ca
Test PR (#3760)
agjohnson Mar 9, 2018
32670cb
Remove inline style
stsewd Mar 9, 2018
e38d16c
Try to fix end of file (#3761)
humitos Mar 10, 2018
3b5cd7c
Fix tox env: coverage
stsewd Mar 12, 2018
50f1e44
Merge pull request #3772 from stsewd/fix-coverage-env
ericholscher Mar 12, 2018
68f4ab6
Merge branch 'fix-bug-translations'
agjohnson Mar 12, 2018
0ee36aa
Bump to version 2.3.0
agjohnson Mar 12, 2018
cca6a0a
Because font files
agjohnson Mar 12, 2018
8f2d59c
Changelog for 2.3.0
agjohnson Mar 12, 2018
8a2a95e
Fixed a grammatical error
durwasa-chakraborty Mar 12, 2018
e5facfe
Merge remote-tracking branch 'davidfischer/use-sustainability-api'
ericholscher Mar 13, 2018
fde9c8a
Add sustainability api to CORS
ericholscher Mar 13, 2018
d918a0f
Don't do domain checking on sustainability api
ericholscher Mar 13, 2018
d16f365
Use JSONP for sustainability API
davidfischer Mar 13, 2018
f1dc3df
added lint rules
bansalnitish Mar 11, 2018
3306d3a
Merge pull request #3666 from rtfd/humitos/django-pagination/upgrade
humitos Mar 13, 2018
4015c03
Merge pull request #3780 from durwasa-chakraborty/master
RichardLitt Mar 14, 2018
74bbb3a
Merge pull request #3768 from bansalnitish/eslint
davidfischer Mar 14, 2018
1db9bbd
Merge pull request #3472 from rtfd/humitos/docs/improve-sharing
humitos Mar 15, 2018
50e7d4b
Upgrade all packages using `pur` tool (#2916)
humitos Mar 15, 2018
d30cc12
Upgrade docker-py to its latest version (docker==3.1.1) (#3243)
humitos Mar 15, 2018
e73b266
Allow members of "Admin" Team to wipe version envs (#3791)
humitos Mar 15, 2018
689f6a2
Remove pinned CSS Select version
davidfischer Mar 16, 2018
167a8ef
Update and rename using-requirements-file.rst to specifying-dependenc…
kchawla-pi Mar 19, 2018
587f853
Updated & Renamed using-requirements-file.rst
kchawla-pi Mar 19, 2018
7893451
Merge branch 'requirements-file' of github.com:kchawla-pi/readthedocs…
kchawla-pi Mar 19, 2018
673bfc7
Pin astroid to fix linter issue on travis (#3816)
stsewd Mar 20, 2018
24ee5e5
Merge branch 'master' into sustainability-api-jsonp
davidfischer Mar 20, 2018
10c2bdf
Reorder GSOC projects, and note priority order (#3823)
ericholscher Mar 20, 2018
5edf99f
Bump docker -> 3.1.3 (#3828)
agjohnson Mar 20, 2018
ed5a1bd
Autolint cleanup for #3821 (#3822)
agjohnson Mar 20, 2018
2a79250
Update instance and model when `record_as_success` (#3831)
humitos Mar 22, 2018
bd36494
Add temporary method for skipping submodule checkout (#3821)
agjohnson Mar 22, 2018
25ac414
Release 2.3.1
agjohnson Mar 22, 2018
43de909
Add Project model validation to repo URL
humitos Mar 13, 2018
8e5cce2
Merge branch 'humitos/import/url-repo-validation'
agjohnson Mar 23, 2018
233febf
Release 2.3.2
agjohnson Mar 23, 2018
7ac7dfc
Save docker image hash to consider when auto wiping the environment (…
humitos Mar 23, 2018
b242b41
Define useful celery beat task for development (#3762)
humitos Mar 23, 2018
da56a7d
Task to remove orphan symlinks (#3543)
humitos Mar 23, 2018
ded401e
Auto-generate conf.py compatible with Py2 and Py3 (#3745)
humitos Mar 23, 2018
3c674f0
Use readthedocs-common to share linting files accross different repos…
humitos Mar 23, 2018
c5d102a
Documentation for RTD context sent to the Sphinx theme (#3490)
humitos Mar 23, 2018
2d6d2a0
Show link to docs on a build (#3446)
stsewd Mar 23, 2018
f3c0c0a
Fix regex for public bitbucket repo (#3533)
stsewd Mar 23, 2018
d6a51a4
Check submodule URLs integrity using gitpython
humitos Mar 23, 2018
8a34d5e
Add validation for submodule URLs as well
agjohnson Mar 24, 2018
7b8efe3
Fix linting issues (#3838)
humitos Mar 24, 2018
ca35951
Merge pull request #3789 from davidfischer/sustainability-api-jsonp
davidfischer Mar 26, 2018
4b3fd71
Merge branch 'master' into remove-pinned-cssselect
davidfischer Mar 26, 2018
6d32b25
Fix linting errors in tests
davidfischer Mar 26, 2018
7125a88
Merge pull request #3855 from davidfischer/fix-linting-errors
davidfischer Mar 26, 2018
dcd998b
Merge branch 'master' into remove-pinned-cssselect
davidfischer Mar 26, 2018
5a39385
Merge pull request #3813 from davidfischer/remove-pinned-cssselect
davidfischer Mar 26, 2018
d8f603c
Revert "Save docker image hash to consider when auto wiping the envir…
agjohnson Mar 26, 2018
bed1828
Release 2.3.3
agjohnson Mar 26, 2018
735a633
Update static assets
agjohnson Mar 26, 2018
f4e645d
Release 2.3.4
agjohnson Mar 27, 2018
f2ac3cc
Another CORS hotfix for the sustainability API
davidfischer Mar 27, 2018
adb5392
Merge pull request #3862 from davidfischer/sustain-cors-hotfix
ericholscher Mar 27, 2018
54cc39f
written guide for elasticsearch
irkartik Mar 26, 2018
84aea29
added links for installation of JDK
irkartik Mar 27, 2018
53f4124
updated official links for JDK
irkartik Mar 27, 2018
ca6bcd1
corrected typo in features.rst
irkartik Mar 27, 2018
f10e745
deleted unintended file
irkartik Mar 27, 2018
4e43caf
add description for tox tasks
gaborbernat Mar 28, 2018
af4e06d
Merge pull request #3868 from gaborbernat/tox
ericholscher Mar 28, 2018
2fd1958
Merge pull request #3872 from rajujha373/typo-correction
ericholscher Mar 29, 2018
4b28325
#3718: Added date to changelog (#3788)
irkartik Mar 29, 2018
873108b
Fix up some of the logic around repo and submodule URLs (#3860)
agjohnson Mar 29, 2018
7aa6f4d
Use gitpython to find a commit reference (#3843)
agjohnson Mar 29, 2018
7f2d711
Added documentation for using a pip requirements file
kchawla-pi Feb 18, 2018
8835b8b
Fixed issues pointed out in first pull request review
kchawla-pi Feb 19, 2018
cb555d4
Added label for `Can I document ... root of my repository`
kchawla-pi Feb 19, 2018
5a4503d
Added `Using pip requirments file with a YAML config file
kchawla-pi Feb 19, 2018
d2acfa2
Fixed label `faq_document_package_not_at_root`
kchawla-pi Feb 19, 2018
25ef46e
Changed section header underlines
kchawla-pi Feb 21, 2018
d273e30
Added :maxdepth: 1
kchawla-pi Feb 21, 2018
5e98ece
Fixed: Headings and body text, typos
kchawla-pi Feb 21, 2018
251945b
Added clarification + language & punctuation tweaks
kchawla-pi Feb 21, 2018
9be835a
Removed redundant/verbose text from first section
kchawla-pi Feb 21, 2018
c7c2e05
Added section for using conda environment.yml
kchawla-pi Feb 21, 2018
22fceec
Fixed :doc: referrer to conda.rst
kchawla-pi Feb 21, 2018
0d78a94
Fixed minor typo and formatting
kchawla-pi Feb 21, 2018
31581e4
Simplified the documentation siginificantly
kchawla-pi Feb 27, 2018
dc1159c
Fixed yaml code block formatting
kchawla-pi Feb 27, 2018
887c25b
Update and rename using-requirements-file.rst to specifying-dependenc…
kchawla-pi Mar 19, 2018
ddda401
Merge branch 'requirements-file' of github.com:kchawla-pi/readthedocs…
kchawla-pi Mar 30, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 104 additions & 0 deletions docs/guides/using-requirements-file.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
Read the Docs: Using a requirements file
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the Read the Docs prefix isn't necessary, and we use title-case for h1 headers

========================================

The requirements file option is useful in the following scenarios:
- You are using external packages, extensions, and themes that you need to include in your documentation project
- You have enabled the install project in a virtual environment option, but your package's setup.py file is not in the root directory.
- You have multiple python packages in your project and you wish to document them.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This block of copy can be reduced. We probably don't need to outline any of the scenarios where you might need a requirements.txt, as this doesn't really help the user solve the problem of setting up a requirements file. We can give the reader less to parse by simply stating that requirements files are useful for specifying dependencies.


-----------------------------
Using a pip requirements file
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This duplicates the top heading. I think it can safely be removed.

-----------------------------

Creating the requirements file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You are using external packages, extensions, and themes that you need to include in your documentation project
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This heading is very long and probably should probably be shorter. I realize the idea was to match the 3 cases outlined in the first section but perhaps something like "Supporting external packages, extensions, and themes" would work.

---------------------------------------------------------------------------------------------------------------

Read the Docs supports adding specific functionality, and themes to tailor the behavior and appearance
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comma here is unnecessary.

of your project's documentation. This is done by specifying a list of the packages, extensions, themes, to be used,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"packages, extensions, themes, to be used," -> "packages, extensions, and themes to be used"

and their versions, during the documentation build process.

For example, one can specify which version of *Sphinx* to use, which theme they would like to use,
what extensions they would like to add and so on.

To do this, one can create a list of requirements and save it in a requirements file.

Since *RTD* uses Python language to build the workflow which automatically converts and hosts your project's
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"uses Python language" -> "uses the Python language"

documentation, and uses various python packages for this, the requirments file is the same as any standard python project.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"requirments" -> "requirements"

Read the Docs installs them in a virtual environment using pip, the standard python package manager.

In-fact, it is helpful to think of your documentation on readthedocs as a sub-project written in python,
within your main project's repo.

To use the requirements file:
Create a text file with a sensible name in the root directory of your documentation directory. For example::

docs/requirements.txt
docs/requirements-docs.txt

This is a standard python requirements file. If you know how to use that, this is the same thing. If not, read on.
In this file, list all the packages (one package per line) that you require for building your documentation.
Make sure to specify their appropriate version.

For example, say you wish to only use Sphinx version 1.1.x and the sphinx_rtd_theme with a minimum version of 0.1.9.
You are also using external extensions, for example, the napolean extension, (make sure to specify them in
the extensions list in conf.py file), then your requirements file might look something like this:

::

# <insert optional comment explaining why this package or version is a requirement>
sphinx == 1.1.*
sphinx_rtd_theme >= 0.1.9
sphinxcontrib-napolean
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think most of this content can be better served by leaning on the Python packaging resources to explain what a requirements file is, how to use it, and how to maintain a good file.

What's important to readers here is how to make this work with RTD:

  • Where does the file live
  • How do I add this to my project
  • How do I know it's working

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestions for How do I know it's working?



You have enabled the install project in a virtual environment option, but your package's setup.py file is not in the root directory.
---------------------------------------------------------------------------------------------------------------------------------------
OR
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are headers with permalinks. A shorter heading would be better.

screen shot 2018-02-20 at 4 16 19 pm

--
You have multiple python packages in your project and you wish to document them.
--------------------------------------------------------------------------------

If you enable the option to install your project in a virtual environment, RTD automatically uses
your project's setup.py file to install the packages. For this to work, the ``setup.py`` file must be
in the root directory of your project.

However, if you want to place your packages at a different location from the project's root directory,
or your project has multiple python packages that you wish to document, then you can create a requirements file
and specify the relative paths to your packages inside that file.

For example, if you want to keep your python package in the ``src/python`` directory, located at the root of your project,
create a ``requirements.readthedocs.txt`` file in your project root pointing to this path.
Make sure that the path to the packages' root directory is relative to the path of the ``requirements.readthedocs.txt`` file.

So if the requirements file is at the project root::

/requirements.readthedocs.txt

its content will be::

/src/python/

If you want to put the requirements in the file::

/requirements/readthedocs.txt

its contents will be::

../src/python/

Using the requirements file
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Now, once the requirements file has been created for either scenario;

- Login to your Read the Docs project ( you have to be admin of the project).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a trailing whitespace on the (

- Go to My Projects (using the drop-down arrow next to your username in the top right).
- From the list of your Read the Docs projects, click on the project you wish to modify.
- Click on the Admin button along the top row.
- Go to advanced settings.
- Enable the option ``Install your project inside a virtualenv using setup.py install``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The install project option is not mandatory for using the requirements file option

- In the ``Requirements File:`` text-box below that, specify the path of the requirements file you just created.
- The path should be relative to the root directory of the documentation project.