https://github.com/o3-shop/o3-documentation
https://github.com/o3-shop/o3-documentation
documentation
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/o3-shop/o3-documentation
- Owner: o3-shop
- License: gpl-3.0
- Created: 2023-12-28T19:43:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-09T10:27:32.000Z (about 2 years ago)
- Last Synced: 2025-02-03T20:03:26.100Z (over 1 year ago)
- Topics: documentation
- Language: HTML
- Size: 3.31 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# O3-Shop documentation
These are the sources for the generated documentation at [https://docs.o3-shop.com](https://docs.o3-shop.com).
## Contribute
If you have a suggestion for improvement, create a fork of the repository and create a pull request. Alternatively, you can simply create an issue. Add the project to your favourites. Thank you.
- Create a fork of the project
- Create a feature branch (git checkout -b feature/AmazingFeature).
- Add your changes (git commit -m 'Add some AmazingFeature').
- commit the branch (git push origin feature/AmazingFeature)
- Open a pull request
## Local development
For development purposes, the documentation can be created locally. This saves unnecessary correction runs.
Assuming you have Python already, install Sphinx:
```
pip install sphinx
pip install myst-parser
pip install sphinx-rtd-theme
```
Check out the fork and change to the root directory.
Now, edit your desired files or add new content. Orientate the document structure on the existing elements.
Execute this command to start the build:
```
make html
```
You will find the generated project in the folder `build/html`.
If you are satisfied with your adjustments, transfer them to us as a merge request.
Many thanks for your contribution.