+ 
-
+
Doing dirty (but extremely useful) things with equals. diff --git a/docs/plugins.py b/docs/plugins.py index 743ab24..06f6189 100644 --- a/docs/plugins.py +++ b/docs/plugins.py @@ -15,23 +15,7 @@ def on_pre_build(config: Config): - test_examples() - - -def test_examples(): - """ - Run the examples tests. - """ - try: - run_pytest = getattr('pytest', 'main') - except AttributeError: - logger.info('pytest not installed, skipping examples tests') - else: - logger.info('running examples tests...') - return_code = run_pytest(['-q', '-p', 'no:sugar', 'tests/test_docs.py']) - if return_code != 0: - logger.warning('examples tests failed') - + pass def on_files(files: Files, config: Config) -> Files: return remove_files(files) @@ -53,21 +37,13 @@ def remove_files(files: Files) -> Files: def on_page_markdown(markdown: str, page: Page, config: Config, files: Files) -> str: - markdown = reinstate_code_titles(markdown) return add_version(markdown, page) -def reinstate_code_titles(markdown: str) -> str: - """ - Fix titles in code blocks, see https://youtrack.jetbrains.com/issue/PY-53246. - """ - return re.sub(r'^(```py)\s*\ntitle=', r'\1 title=', markdown, flags=re.M) - - def add_version(markdown: str, page: Page) -> str: - if page.abs_url == '/': + if page.file.src_uri == 'index.md': version_ref = os.getenv('GITHUB_REF') - if version_ref: + if version_ref and version_ref.startswith('refs/tags/'): version = re.sub('^refs/tags/', '', version_ref.lower()) version_str = f'Documentation for version: **{version}**' else: diff --git a/mkdocs.yml b/mkdocs.yml index 3e17d73..6209823 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -63,6 +63,8 @@ markdown_extensions: emoji_generator: !!python/name:materialx.emoji.to_svg extra: + version: + provider: mike analytics: provider: google property: G-FLP20728CW @@ -76,6 +78,9 @@ watch: - dirty_equals plugins: + - mike: + alias_type: symlink + canonical_version: latest - search - mkdocstrings: handlers: diff --git a/requirements/docs.in b/requirements/docs.in index 0404e9e..b5f7e63 100644 --- a/requirements/docs.in +++ b/requirements/docs.in @@ -1,4 +1,6 @@ black +# waiting for https://github.com/jimporter/mike/issues/154 +git+https://github.com/jimporter/mike.git mkdocs mkdocs-material mkdocs-simple-hooks diff --git a/requirements/docs.txt b/requirements/docs.txt index eb5936c..411cc00 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -1,6 +1,6 @@ # -# This file is autogenerated by pip-compile with Python 3.10 -# by the following command: +# This file is autogenerated by pip-compile with python 3.10 +# To update, run: # # pip-compile --output-file=requirements/docs.txt requirements/docs.in # @@ -24,8 +24,13 @@ griffe==0.27.1 # via mkdocstrings-python idna==3.4 # via requests +importlib-metadata==6.6.0 + # via mike +importlib-resources==5.12.0 + # via mike jinja2==3.1.2 # via + # mike # mkdocs # mkdocs-material # mkdocstrings @@ -42,9 +47,12 @@ markupsafe==2.1.2 # mkdocstrings mergedeep==1.3.4 # via mkdocs +mike @ git+https://github.com/jimporter/mike.git + # via -r requirements/docs.in mkdocs==1.4.2 # via # -r requirements/docs.in + # mike # mkdocs-autorefs # mkdocs-material # mkdocs-simple-hooks @@ -83,6 +91,7 @@ python-dateutil==2.8.2 # via ghp-import pyyaml==6.0 # via + # mike # mkdocs # pymdown-extensions # pyyaml-env-tag @@ -98,5 +107,9 @@ tomli==2.0.1 # via black urllib3==1.26.15 # via requests +verspec==0.1.0 + # via mike watchdog==3.0.0 # via mkdocs +zipp==3.15.0 + # via importlib-metadata