https://github.com/ds-wizard/guide
https://github.com/ds-wizard/guide
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ds-wizard/guide
- Owner: ds-wizard
- License: cc-by-sa-4.0
- Created: 2022-09-16T08:26:21.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2025-12-12T09:57:13.000Z (6 months ago)
- Last Synced: 2025-12-13T22:23:11.297Z (6 months ago)
- Size: 313 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# DSW User Guide
[](LICENSE)
[](https://bestpractices.coreinfrastructure.org/projects/4975)
## Usage
### Install Requirements
```
pip install -r docs/requirements.txt
```
Extra requirements only for development:
```
pip install -r docs/requirements.dev.txt
```
### Generate Guide
```
cd docs
make help
make html
```
### Develop Guide
```
make watch
```
Use [Python Developer’s Guide](https://devguide.python.org/documentation/markup/) as a reference for writing RST, specific rules are listed in the [CONTRIBUTING](CONTRIBUTING.md) file.
### Refresh Dependencies
```
rm -r env
python -m venv env
source env/bin/activate
pip install -r docs/requirements.direct.txt
pip freeze > docs/requirements.txt
```
## References
* [Sphinx Documentation](https://www.sphinx-doc.org/en/master/)
* [reStructuredText Markup Specification](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html)
* [RST Cheatsheet](https://github.com/ralsina/rst-cheatsheet)
* [Git Basics](https://www.atlassian.com/git)
* [How to Write a Git Commit Message](https://cbea.ms/git-commit/)
## License
This project is licensed under the Creative Commons Attribution-ShareAlike (CC BY-SA) - see the
[LICENSE](LICENSE) file for more details.