https://github.com/abeusher/simplediagrams_docs
Documentation for SimpleDiagrams v4 and above.
https://github.com/abeusher/simplediagrams_docs
Last synced: 3 months ago
JSON representation
Documentation for SimpleDiagrams v4 and above.
- Host: GitHub
- URL: https://github.com/abeusher/simplediagrams_docs
- Owner: abeusher
- Created: 2017-04-14T01:53:37.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-16T09:31:34.000Z (about 9 years ago)
- Last Synced: 2025-01-14T12:13:39.349Z (over 1 year ago)
- Size: 1.8 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
SimpleDiagrams Documentation
This repo contains the SimpleDiagrams documentation.
The complexity in working with these docs is that I use a custom theme. This custom theme is included via pip and stored in the virualenv.
You can see this in the following line in the requirements:
`-e git+https://github.com/danielmcquillen/sphinx_rtd_theme.git#egg=simplediagrams_sphinx_theme`
So, if I make a change to that theme, I have to
1. (be working in simplediagrams4-docs-theme virtualenv)
2. Run `grunt` to compile theme changes
3. Commit changes to github repo
4. Get the dependency updated in this virtual env so that the new styles are captured when doing a `make html`
5. Finally, push docs changes here to git so that ReadTheDocs picks them up. The new styles should go along for the ride.
Looks like doing a
`pip install -r requirements.txt --ugprade` is does get the theme to update, but somehow `make html` doesn't pick it up.