Provide a requirements file

[Paebbels]

Please add a requirements.txt file to your main directory. This file can be used by:

• a user to install all requirements for your code:
  pip install -r requirements.txt
• Sphinx to resolve more symbols while automatically creating your Python code documentation
• requires.io to check your dependencies for outdated or insecure module usages
• Landscape.io to resolve more symbols while checking your code quality.

Here is the PIP documentation for requirements.txt files.

Example for your project:

lxml

You should also add a second requirements.txt file in your documentation directory for Sphinx. By splitting both requirements, you won't annoy normal users with requirements needed to build the documentation. Please note, it can recursively refer to other files with -r <path>:

-r ../../requirements.txt
sphinx
# Are there any external Sphinx extensions?

(This will also load the main requirements file, which required lxml.)

Please specify the path to the Sphinx/ReadTheDocs specific requirements file in a ReadTheDocs configuration file (.readthedocs.yml):

requirements_file: docs/requirements.txt
python:
  version: 3

(It also sets Python to Python 3.x)

[NJDFan]

Main requirements.txt is written; Sphinx specific is still to come.