https://github.com/hedzr/sphinx-study
a notebook for studying sphinx documenter
https://github.com/hedzr/sphinx-study
sphinx-doc sphinx-docs sphinx-documentation
Last synced: about 9 hours ago
JSON representation
a notebook for studying sphinx documenter
- Host: GitHub
- URL: https://github.com/hedzr/sphinx-study
- Owner: hedzr
- Created: 2022-07-21T02:33:19.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-16T04:08:11.000Z (about 3 years ago)
- Last Synced: 2025-03-04T17:41:13.921Z (about 1 year ago)
- Topics: sphinx-doc, sphinx-docs, sphinx-documentation
- Language: JavaScript
- Homepage: https://hz-sphinx-study.readthedocs.io/
- Size: 5.7 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sphinx study
[Latest ](https://hz-sphinx-study.readthedocs.io/en/latest/?badge=latest)
[Stable ](https://hz-sphinx-study.readthedocs.io/en/stable/?badge=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](https://readthedocs.org/projects/hz-sphinx-study/)
## Build
The following command will install the packages according to the configuration file requirements.txt.
install
```bash
pip install -r requirements.txt
```
freeze
```bash
pip freeze > requirements.txt
```
list
```bash
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](https://github.com/bndr/pipreqs), once installed with the following command:
```bash
pip install pipreqs
```
running pipreqs in the command line generates a `requirements.txt` file automatically:
```bash
$ pipreqs /home/project/location
Successfully saved requirements file in /home/project/location/requirements.txt
```