https://github.com/compas-dev/sphinx_compas2_theme

Sphinx theme for COMPAS 2 based on pydata-sphinx-theme and sphinx-book-theme

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
○
.zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
1 of 3 committers (33.3%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (11.2%) to scientific vocabulary

Keywords

compas documentation sphinx-theme

Keywords from Contributors

rhino3d assemblies booleans cgal remeshing slicing geometry

Last synced: 5 months ago · JSON representation

Repository

Sphinx theme for COMPAS 2 based on pydata-sphinx-theme and sphinx-book-theme

Basic Info

Host: GitHub
Owner: compas-dev
License: mit
Language: Python
Default Branch: main
Homepage: http://compas.dev/sphinx_compas2_theme/
Size: 12.1 MB

Statistics

Stars: 1
Watchers: 5
Forks: 0
Open Issues: 0
Releases: 10

Topics

compas documentation sphinx-theme

Created about 2 years ago · Last pushed about 2 years ago

Metadata Files

Readme Changelog Contributing License Code of conduct Authors

README.md

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 select Command 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
```

Owner

Name: compas-dev
Login: compas-dev
Kind: organization

Website: https://compas.dev
Repositories: 45
Profile: https://github.com/compas-dev

COMPAS - an open source computational framework for research and collaboration in AEC

GitHub Events

Total

Fork event: 1

Last Year

Fork event: 1

Committers

Last synced: 8 months ago

All Time

Total Commits: 51
Total Committers: 3
Avg Commits per committer: 17.0
Development Distribution Score (DDS): 0.157

Past Year

Commits: 0
Committers: 0
Avg Commits per committer: 0.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
tomvanmele	t**e@g**m	43
Gonzalo Casas	c**s@a**h	7
Li	l**0@g**m	1

Committer Domains (Top 20 + Academic)

arch.ethz.ch: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 0
Total pull requests: 1
Average time to close issues: N/A
Average time to close pull requests: 42 minutes
Total issue authors: 0
Total pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 1.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

gonzalocasas (1)

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- pypi 4,628 last-month

Total dependent packages: 16
Total dependent repositories: 0
Total versions: 10
Total maintainers: 1

pypi.org: sphinx-compas2-theme

COMPAS 2 Theme for Sphinx

Homepage: https://github.com/compas-dev/sphinx_compas2_theme
Documentation: https://sphinx-compas2-theme.readthedocs.io/
License: MIT license
Latest release: 0.1.10
published about 2 years ago

Versions: 10
Dependent Packages: 16
Dependent Repositories: 0
Downloads: 4,628 Last month

Rankings

Dependent packages count: 10.2%

Average: 38.6%

Dependent repos count: 67.0%

Maintainers (1)

compas-dev

Last synced: 6 months ago

Dependencies

.github/workflows/build.yml actions

compas-dev/compas-actions.build v3 composite

.github/workflows/docs.yml actions

compas-dev/compas-actions.docs v2 composite

.github/workflows/pr-checks.yml actions

Zomzog/changelog-checker v1.2.0 composite
actions/checkout v1 composite

.github/workflows/release.yml actions

compas-dev/compas-actions.build v3 composite
compas-dev/compas-actions.publish v2 composite

pyproject.toml pypi

requirements-dev.txt pypi

attrs >=17.4 development
black ==22.12.0 development
bump2version >=1.0.1 development
check-manifest >=0.36 development
compas_invocations * development
doc8 * development
flake8 * development
invoke >=0.14 development
isort * development
twine * development
wheel * development

requirements.txt pypi

compas *
jinja2 >=3.0
numpydoc *
pydata-sphinx-theme >=0.13,<0.14
pydocstyle *
pytest *
pytest-mock *
sphinx ==4.5
sphinx-copybutton *
sphinx-design *
sphinx-favicon *
sphinx-inline-tabs *
sphinx-remove-toctrees *
sphinx-togglebutton *
sphinx_book_theme *
sphinxcontrib-bibtex *
sphinxcontrib-youtube *

setup.py pypi