Skip to content

Commit

Permalink
Merge branch '2-create-package-structure-for-first-draft'
Browse files Browse the repository at this point in the history
  • Loading branch information
ClaasRostock committed Feb 20, 2024
2 parents 560f596 + 7c104d4 commit 3daaea4
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 76 deletions.
150 changes: 75 additions & 75 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,75 +1,75 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys

sys.path.insert(0, os.path.abspath("../../src"))


# -- Project information -----------------------------------------------------

project = "maritime-schema"
copyright = "2024, DNV"
author = "Author One, Author Two, Claas Rostock"

# The full version, including alpha/beta/rc tags
release = "0.0.3b1"

# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"myst_parser",
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx_argparse_cli",
]

# The file extensions of source files.
source_suffix = {
".rst": "restructuredtext",
".md": "markdown",
}

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "furo"
html_logo = "_static/maritime_schema.svg"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]

autodoc_default_options = {
"member-order": "bysource",
"undoc-members": True,
"exclude-members": "__weakref__",
}
autodoc_preserve_defaults = True

myst_heading_anchors = 3
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys

sys.path.insert(0, os.path.abspath("../../src"))


# -- Project information -----------------------------------------------------

project = "maritime-schema"
copyright = "2024, DNV"
author = "Author One, Author Two, Claas Rostock"

# The full version, including alpha/beta/rc tags
release = "0.0.3b2"

# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"myst_parser",
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx_argparse_cli",
]

# The file extensions of source files.
source_suffix = {
".rst": "restructuredtext",
".md": "markdown",
}

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "furo"
html_logo = "_static/maritime_schema.svg"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]

autodoc_default_options = {
"member-order": "bysource",
"undoc-members": True,
"exclude-members": "__weakref__",
}
autodoc_preserve_defaults = True

myst_heading_anchors = 3
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "maritime-schema"
version = "0.0.3b1"
version = "0.0.3b2"
description = "Python data classes and JSON schemata for maritime traffic scenarios."
readme = "README.md"
requires-python = ">= 3.9"
Expand Down

0 comments on commit 3daaea4

Please sign in to comment.