https://github.com/pybites/platform-docs
Documentation for our platform (CodeChalleng.es)
https://github.com/pybites/platform-docs
Last synced: about 2 months ago
JSON representation
Documentation for our platform (CodeChalleng.es)
- Host: GitHub
- URL: https://github.com/pybites/platform-docs
- Owner: pybites
- Created: 2019-05-19T21:56:38.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-06T03:34:01.000Z (3 months ago)
- Last Synced: 2025-04-12T23:48:22.424Z (about 2 months ago)
- Size: 22.2 MB
- Stars: 2
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PyBites Platform Docs
This is the docs repo of [CodeChalleng.es](https://codechalleng.es/)
## Contribute
* Fork this repo: [https://github.com/pybites/platform-docs](https://github.com/pybites/platform-docs)
* Clone the fork, for example: `git clone [email protected]:bbelderbos/platform-docs.git platform-docs-bob`
* Create a virtual env and install the dependencies:
cd platform-docs-bob
python3.7 -m venv venv && source venv/bin/activate
pip install -r requirements.txt
* Write documentation in `docs`, see [sphinx docs](http://www.sphinx-doc.org/en/master/) for reference and the `rst` files in `docs/` for examples.
* Check documentation locally (from root folder): `sphinx-build -b html docs docs/build`, check if it is what you want: `open docs/build/` / open `index.html`.
* If so, commit your changes (`docs/build` output dir should be ignored, see `.gitignore`).
* Push your changes to your fork and open a PR against our repo to get it merged in.