sphinx study

Latest Stable

a notebook for studying sphinx documenter.

This repo is a expeiremental notebook for studying how to use sphinx to build a online docsite.

status admin

Build

The following command will install the packages according to the configuration file requirements.txt.

install

pip install -r requirements.txt

freeze

pip freeze > requirements.txt

list

pip list

How to Create Python Requirements File After Development

While it is possible to create it manually, it is a good practice to use the pipreqs module. It is used to scan your imports and build a Python requirements file for you.

According to THE DOCUMENTATION, once installed with the following command:

pip install pipreqs

running pipreqs in the command line generates a requirements.txt file automatically:

$ pipreqs /home/project/location
Successfully saved requirements file in   /home/project/location/requirements.txt