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
Hashes for sphinx-compas2-theme-0.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ee3d02947f52f8a07583c575abe033389afd0fc57dbbb17b9de860cb32a2597 |
|
MD5 | c15ebbeaf220df8b5e7e5b4bd8f7607b |
|
BLAKE2b-256 | e7860e9d03a351d439536d8b96614e1090286cb7c9679e836c9c20ff3c1d33d9 |
Hashes for sphinx_compas2_theme-0.1.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73ca3a1f6e229325809f2db0bf30f5bd1e5f78fbae6810b689bd69a5f9bf4fc5 |
|
MD5 | bf5ed3290910977087fd047548fc58ba |
|
BLAKE2b-256 | 345dddd2d63921c18d3f9f5a62198c15ff82a8aa99bae953a47737f965ea9cdd |