Skip to content

Development docs - minor improvements #314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
castelao wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Development docs - minor improvements #314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2c47535
cfg: Adding myst-parser as dependency for doc
castelao Oct 21, 2025
58843f0
cfg: Adding myst_parser as extension for Sphinx
castelao Oct 21, 2025
bf2a04f
Short name version for Gui
castelao Oct 21, 2025
186753f
Note about Ruff on import style
castelao Oct 21, 2025
f1cff81
Explicit command to help new users
castelao Oct 21, 2025
c3c2adf
cfg: Extending sufix covered
castelao Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
"sphinx_click.ext",
"sphinx_tabs.tabs",
"sphinx_copybutton",
"myst_parser",
]

intersphinx_mapping = {
Expand All @@ -78,7 +79,11 @@
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
source_suffix = ".rst"
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': 'markdown',
}

# source_parsers = {'.md': MarkdownParser}

Expand Down
5 changes: 3 additions & 2 deletions docs/source/dev/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ learn how to `create a branch <https://docs.github.com/en/pull-requests/collabor
and `request a review <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review>`_.

If you are not sure where or how to start contributing to COMPASS, consider reaching out to the
current developer(s): **Paul Pinchuk** ["ppinchuk@nrel.gov"] or **Guilherme Pimenta Castelao** ["gpimenta@nrel.gov"].
current developer(s): **Paul Pinchuk** ["ppinchuk@nrel.gov"] or **Guilherme Castelao** ["gpimenta@nrel.gov"].

When you are ready to contribute to COMPASS, clone a copy of the COMPASS repository from GitHub, check out your
own branch, and make the appropriate changes locally. Ensure that your new code adheres to all of the guidelines
Expand Down Expand Up @@ -121,6 +121,7 @@ Use the following import conventions::
import numpy as np
import pandas as pd

Note that ``ruff`` will monitor and enforce some style rules such as ordering of imports.

Test coverage
-------------
Expand All @@ -132,7 +133,7 @@ You can run python COMPASS tests locally using ``pixi``:

.. code-block:: shell

pixi r -e ptest tests
pixi run -e ptest tests

Tests for a module should ideally cover all code in that module,
i.e., statement coverage should be at 100%, though this alone does not ensure that
Expand Down
Loading