Skip to content

Commit

Permalink
Auto update doc copyright year (#72)
Browse files Browse the repository at this point in the history
* automatically set docs' copyright and version
* doc builds use editable install of cpp-linter pkg
  • Loading branch information
2bndy5 committed Feb 12, 2024
1 parent 03934bb commit cc8b181
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
python-version: 3.x

- name: Install docs dependencies
run: pip install -r docs/requirements.txt -r requirements.txt
run: pip install -r docs/requirements.txt -e .

- name: Build docs
run: sphinx-build docs docs/_build/html
Expand Down
12 changes: 5 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,19 @@
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

import sys
import re
from pathlib import Path
import time
from importlib.metadata import version as get_version
from sphinx.application import Sphinx

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

from cpp_linter.cli import cli_arg_parser # noqa: E402
from cpp_linter.cli import cli_arg_parser

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = "cpp-linter"
copyright = "2022, 2bndy5"
copyright = f"{time.localtime().tm_year}, 2bndy5"
author = "2bndy5"
release = "2.0.0"
release = get_version("cpp-linter")

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down

0 comments on commit cc8b181

Please sign in to comment.