sphinx-compas2-theme 0.1.9

COMPAS 2 Theme for Sphinx

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 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 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 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 versioning convention.

1. Create a new release

    invoke release major