COMPAS 2 Theme for Sphinx
Project description
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
- Open project folder in VS Code
- Select python environment for the project
- First time using VS Code and on Windows? Make sure select the correct terminal profile:
Ctrl+Shift+P
,Terminal: Select Default Profile
and selectCommand Prompt
.
All terminal commands in the following sections can be run from the VS Code integrated terminal.
First steps with git
- Go to the
Source control
tab - Make an initial commit with all newly created files
First steps with code
-
Install the newly created project
pip install -e .
-
Install it on Rhino
python -m compas_rhino.install
Code conventions
Code convention follows PEP8 style guidelines and line length of 120 characters.
-
Check adherence to style guidelines
invoke lint
-
Format code automatically
invoke format
Documentation
Documentation is generated automatically out of docstrings and RST files in this repository
-
Generate the docs
invoke docs
-
Check links in docs are valid
invoke linkcheck
-
Open docs in your browser (file explorer ->
dist/docs/index.html
)
Testing
Tests are written using the pytest framework
-
Run all tests from terminal
invoke test
-
Or run them from VS Code from the
Testing
tab
Publish release
Releases follow the semver versioning convention.
-
Create a new release
invoke release major
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinx-compas2-theme-0.1.10.tar.gz
.
File metadata
- Download URL: sphinx-compas2-theme-0.1.10.tar.gz
- Upload date:
- Size: 74.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9ae7a307721001743c98538957b78e614772d72007134e296bf6c85fb8ed48e |
|
MD5 | c6960b0e7b6885c50b020f44bd7ca4bf |
|
BLAKE2b-256 | 0bea128acac73f4f5ae4df0611b59a9de39a9630f51f9e963004a55688e7d0e5 |
File details
Details for the file sphinx_compas2_theme-0.1.10-py2.py3-none-any.whl
.
File metadata
- Download URL: sphinx_compas2_theme-0.1.10-py2.py3-none-any.whl
- Upload date:
- Size: 77.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 74ee20fe0a9152b058a0b005f480ec91b127e31f8db41d56064dbe7267efb2fe |
|
MD5 | 92d0b25554d50e3f154da2636200bf8c |
|
BLAKE2b-256 | 7f96ac839ddbb7fdb347ffc7cc22735d7a5791aea087a51abbe2aa84f7bd4273 |