https://github.com/catalyst-team/catalyst_sphinx_theme
https://github.com/catalyst-team/catalyst_sphinx_theme
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/catalyst-team/catalyst_sphinx_theme
- Owner: catalyst-team
- License: mit
- Created: 2020-03-06T14:28:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-11-29T06:28:36.000Z (over 4 years ago)
- Last Synced: 2024-10-29T12:37:31.495Z (over 1 year ago)
- Language: CSS
- Size: 1.6 MB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Catalyst Sphinx Theme
Sphinx theme for [Catalyst Docs](https://catalyst-team.github.io/catalyst/index.html) based on the [Read the Docs Sphinx Theme](https://sphinx-rtd-theme.readthedocs.io/en/latest).
## Local Development
Run python setup:
```
python setup.py install
```
and install the dependencies using `pip install -r docs/requirements.txt`
In the root directory install the `package.json`:
```
# node version 8.4.0
yarn install
```
If you have `npm` installed then run:
```
npm install
```
- If you want to see generated documentation for `docs/demo` then create
`.env.json` file and make it empty json file. Means `.env.json file` will
contain
```
{}
```
Run grunt to build the html site and enable live reloading of the demo app at `localhost:1919`:
```
grunt
```
The resulting site is a demo.
#### Docs
```
# in ./docs
make html
```
Once these are successful, navigate to the `conf.py` file in each project. In the Docs these are at `./docs/source`. The Tutorials one can be found in the root directory.
In `conf.py` change the html theme to `catalyst_sphinx_theme` and point the html theme path to this repo's local folder, which will end up looking something like:
```
html_theme = 'catalyst_sphinx_theme'
html_theme_path = ["../../../catalyst_sphinx_theme"]
```