https://github.com/compas-dev/sphinx_compas2_theme
Sphinx theme for COMPAS 2 based on pydata-sphinx-theme and sphinx-book-theme
https://github.com/compas-dev/sphinx_compas2_theme
compas documentation sphinx-theme
Last synced: 2 months ago
JSON representation
Sphinx theme for COMPAS 2 based on pydata-sphinx-theme and sphinx-book-theme
- Host: GitHub
- URL: https://github.com/compas-dev/sphinx_compas2_theme
- Owner: compas-dev
- License: mit
- Created: 2023-12-14T07:49:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-09T13:52:35.000Z (over 1 year ago)
- Last Synced: 2025-02-19T16:11:16.350Z (3 months ago)
- Topics: compas, documentation, sphinx-theme
- Language: Python
- Homepage: http://compas.dev/sphinx_compas2_theme/
- Size: 12.1 MB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# Sphinx Theme for COMPAS 2
This is a Sphinx theme for COMPAS 2 based on ``pydata-sphinx-theme`` and ``sphinx-book-theme``.
## Getting started with this project
### Setup code editor
1. Open project folder in VS Code
2. Select python environment for the project
3. First time using VS Code and on Windows? Make sure select the correct terminal profile: `Ctrl+Shift+P`, `Terminal: Select Default Profile` and select `Command Prompt`.
> All terminal commands in the following sections can be run from the VS Code integrated terminal.
### First steps with git
1. Go to the `Source control` tab
2. Make an initial commit with all newly created files
### First steps with code
1. Install the newly created project
pip install -e .
2. Install it on Rhino
python -m compas_rhino.install
### Code conventions
Code convention follows [PEP8](https://pep8.org/) style guidelines and line length of 120 characters.
1. Check adherence to style guidelines
invoke lint
2. Format code automatically
invoke format
### Documentation
Documentation is generated automatically out of docstrings and [RST](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) files in this repository
1. Generate the docs
invoke docs
2. Check links in docs are valid
invoke linkcheck
3. Open docs in your browser (file explorer -> `dist/docs/index.html`)
### Testing
Tests are written using the [pytest](https://docs.pytest.org/) framework
1. Run all tests from terminal
invoke test
2. Or run them from VS Code from the `Testing` tab
### Publish release
Releases follow the [semver](https://semver.org/spec/v2.0.0.html) versioning convention.
1. Create a new release
invoke release major