Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 14 additions & 7 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ the definitions (i.e., codelists) and model mappings for a project are valid.
This can be useful to ensure that all yaml files can be parsed correctly
and that definitions and mappings are internally consistent.

Standard usage
--------------
.. rubric:: Standard usage

Run the following in a command line to ensure that a project folder is a valid
configuration for the **nomenclature** package.
Expand All @@ -18,9 +17,17 @@ configuration for the **nomenclature** package.

nomenclature validate-project /project/folder/

Documentation
-------------
.. rubric:: Table of contents

.. click:: nomenclature:cli
:prog: nomenclature
:nested: full
.. toctree::
Comment thread
dc-almeida marked this conversation as resolved.
Resolved
:maxdepth: 1

cli/validate-yaml
cli/validate-project
cli/check-region-aggregation
cli/export-definitions
cli/list-missing-variables
cli/run-workflow
cli/validate-scenarios
cli/convert-xlsx-codelist-to-yaml
cli/parse-model-registration
7 changes: 7 additions & 0 deletions docs/cli/check-region-aggregation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Check region aggregation
========================

.. typer:: nomenclature.cli:app:check-region-aggregation
:prog: nomenclature check-region-aggregation
:preferred: svg
:make-sections:
7 changes: 7 additions & 0 deletions docs/cli/convert-xlsx-codelist-to-yaml.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Convert Excel codelist to YAML
==============================

.. typer:: nomenclature.cli:app:convert-xlsx-codelist-to-yaml
:prog: nomenclature convert-xlsx-codelist-to-yaml
:preferred: svg
:make-sections:
7 changes: 7 additions & 0 deletions docs/cli/export-definitions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Export definitions
==================

.. typer:: nomenclature.cli:app:export-definitions
:prog: nomenclature export-definitions
:preferred: svg
:make-sections:
7 changes: 7 additions & 0 deletions docs/cli/list-missing-variables.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
List missing variables
======================

.. typer:: nomenclature.cli:app:list-missing-variables
:prog: nomenclature list-missing-variables
:preferred: svg
:make-sections:
7 changes: 7 additions & 0 deletions docs/cli/parse-model-registration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Parse model registration
========================

.. typer:: nomenclature.cli:app:parse-model-registration
:prog: nomenclature parse-model-registration
:preferred: svg
:make-sections:
7 changes: 7 additions & 0 deletions docs/cli/run-workflow.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Run workflow
============

.. typer:: nomenclature.cli:app:run-workflow
:prog: nomenclature run-workflow
:preferred: svg
:make-sections:
7 changes: 7 additions & 0 deletions docs/cli/validate-project.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Validate project
================

.. typer:: nomenclature.cli:app:validate-project
:prog: nomenclature validate-project
:preferred: svg
:make-sections:
7 changes: 7 additions & 0 deletions docs/cli/validate-scenarios.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Validate scenarios
==================

.. typer:: nomenclature.cli:app:validate-scenarios
:prog: nomenclature validate-scenarios
:preferred: svg
:make-sections:
7 changes: 7 additions & 0 deletions docs/cli/validate-yaml.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Validate YAML
=============

.. typer:: nomenclature.cli:app:validate-yaml
:prog: nomenclature validate-yaml
:preferred: svg
:make-sections:
8 changes: 5 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))

import sys
from datetime import datetime
from pathlib import Path

sys.path.insert(0, str(Path(__file__).parent.parent))

import nomenclature

Expand All @@ -40,7 +42,7 @@
"sphinx.ext.autosummary",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
"sphinx_click",
"sphinxcontrib.typer",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
2,004 changes: 660 additions & 1,344 deletions poetry.lock

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ coverage = "^7.3.3"
ruff = "^0.15.7"

[tool.poetry.group.docs.dependencies]
sphinx = "^7.2.6"
sphinx-click = "^5.1.0"
sphinx = "8.2.3"
sphinxcontrib-typer = "^0.10"
numpydoc = "^1.6.0"

[tool.ruff]
Expand Down
Loading