Fix docs build

Signed-off-by: guillemdb <[email protected]>

.bumpversion.cfg

@@ -2,21 +2,22 @@
 current_version = 0.0.0
 commit = True
 tag = True
-[bumpversion:file (badge):README.md]
-search = /v{current_version}.svg
-replace = /v{new_version}.svg
+;[bumpversion:file:docs/_config.yml]
 
-[bumpversion:file (link):README.md]
-search = /v{current_version}...main
-replace = /v{new_version}...main
-[bumpversion:file:docs/_config.yml]
-search = : "{current_version}"
-replace = : "{new_version}"
-
-[bumpversion:file:src/mloq_template/__init__.py]
+[bumpversion:file:src/mloq_template/version.py]
 search = __version__ = "{current_version}"
 replace = __version__ = "{new_version}"
 
 [bumpversion:file:.cookiecutterrc]
 search = version: "{current_version}"
 replace = version: "{new_version}"
+
+;
+;[bumpversion:file (badge):README.md]
+;search = /v{current_version}.svg
+;replace = /v{new_version}.svg
+;
+;[bumpversion:file (link):README.md]
+;search = /v{current_version}...main
+;replace = /v{new_version}...main
+;

.github/workflows/documentation.yml

@@ -23,7 +23,7 @@ defaults:
 
 jobs:
   build:
-
+    if: "contains(github.event.head_commit.message, 'Bump version') && github.ref == 'refs/heads/main'"
     runs-on: ubuntu-latest
 
     steps:

docs/_config.yml

@@ -110,5 +110,5 @@ sphinx:
     napoleon_numpy_docstring  : false
     autodoc_typehints         : "description"
     autoapi_add_toctree_entry : true
-    version                   : "0.0.0"  # The version of the book
-    release                   : "0.0.0"  # The release of the book
+    version                   : 0.0.0  # The version of the book
+    release                   : 0.0.0  # The release of the book

docs/_toc.yml

@@ -2,7 +2,7 @@
 # Learn more at https://jupyterbook.org/customize/toc.html
 
 format: jb-book
-root: intro
+root: index
 chapters:
 - file: markdown
 - file: notebooks

docs/index.md

@@ -2,8 +2,6 @@
 
 This is the main documentation page for **MLOQ Template**.
 
-For the API reference, check out the [API documentation](api/index.md).
-
 This is a small sample book to give you a feel for how book content is
 structured.
 It shows off a few of the major file types, as well as some sample content.

docs/requirements.txt

@@ -0,0 +1,113 @@
+accessible-pygments==0.0.5
+alabaster==0.7.16
+astroid==3.3.4
+asttokens==2.4.1
+attrs==24.2.0
+autoapi==2.0.1
+babel==2.16.0
+beautifulsoup4==4.12.3
+certifi==2024.8.30
+cfgv==3.4.0
+charset-normalizer==3.3.2
+click==8.1.7
+comm==0.2.2
+debugpy==1.8.6
+decorator==5.1.1
+distlib==0.3.8
+distro==1.9.0
+docutils==0.20.1
+exceptiongroup==1.2.2
+executing==2.1.0
+fastjsonschema==2.20.0
+filelock==3.16.1
+flogging==0.0.23
+greenlet==3.1.1
+identify==2.6.1
+idna==3.10
+imagesize==1.4.1
+importlib-metadata==8.5.0
+ipykernel==6.29.5
+ipython==8.27.0
+jedi==0.19.1
+jinja2==3.1.4
+jsonschema==4.23.0
+jsonschema-specifications==2023.12.1
+jupyter-book==1.0.2
+jupyter-cache==1.0.0
+jupyter-client==8.6.3
+jupyter-core==5.7.2
+latexcodec==3.0.0
+linkify-it-py==2.0.3
+markdown-it-py==3.0.0
+markupsafe==2.1.5
+matplotlib-inline==0.1.7
+mdit-py-plugins==0.4.2
+mdurl==0.1.2
+-e file:///home/guillem/mloq-template
+myst-nb==1.1.2
+myst-parser==2.0.0
+nbclient==0.10.0
+nbformat==5.10.4
+nest-asyncio==1.6.0
+nodeenv==1.9.1
+packaging==24.1
+parso==0.8.4
+pexpect==4.9.0
+platformdirs==4.3.6
+pre-commit==3.8.0
+prompt-toolkit==3.0.48
+psutil==6.0.0
+ptyprocess==0.7.0
+pure-eval==0.2.3
+pybtex==0.24.0
+pybtex-docutils==1.0.3
+pydata-sphinx-theme==0.15.4
+pygments==2.18.0
+python-dateutil==2.9.0.post0
+pyyaml==6.0.2
+pyzmq==26.2.0
+referencing==0.35.1
+requests==2.32.3
+rpds-py==0.20.0
+ruyaml==0.91.0
+setuptools==75.1.0
+six==1.16.0
+snowballstemmer==2.2.0
+soupsieve==2.6
+sphinx==7.4.7
+sphinx-autoapi==3.3.2
+sphinx-autodoc2==0.5.0
+sphinx-book-theme==1.1.3
+sphinx-comments==0.0.3
+sphinx-copybutton==0.5.2
+sphinx-design==0.6.1
+sphinx-external-toc==1.0.1
+sphinx-jupyterbook-latex==1.0.0
+sphinx-multitoc-numbering==0.1.3
+sphinx-rtd-theme==2.0.0
+sphinx-thebe==0.3.1
+sphinx-togglebutton==0.3.2
+sphinxcontrib-applehelp==2.0.0
+sphinxcontrib-bibtex==2.6.3
+sphinxcontrib-devhelp==2.0.0
+sphinxcontrib-htmlhelp==2.1.0
+sphinxcontrib-jquery==4.1
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-mermaid==0.9.2
+sphinxcontrib-qthelp==2.0.0
+sphinxcontrib-serializinghtml==2.0.0
+sphinxext-opengraph==0.9.1
+sqlalchemy==2.0.35
+stack-data==0.6.3
+tabulate==0.9.0
+tomli==2.0.1
+tornado==6.4.1
+traitlets==5.14.3
+typing-extensions==4.12.2
+uc-micro-py==1.0.3
+urllib3==2.2.3
+virtualenv==20.26.6
+wcwidth==0.2.13
+wheel==0.44.0
+xxhash==3.5.0
+zipp==3.20.2

pyproject.toml

@@ -330,15 +330,15 @@ PYTHONUNBUFFERED = "1"
 features = ["docs"]
 build = [
     "jupyter-book build docs/ ",
-    "freeze > docs/requirements.txt",
+    "uv pip freeze > docs/requirements.txt",
 ]
 validate = "linkchecker --config .linkcheckerrc --ignore-url=/reference --ignore-url=None site"
-build-check = ["build", "validate"]
+build-check = ["build"] #, "validate"]
 serve = "python3 -m http.server --directory docs/_build/html {args}"
 sphinx = [
     "jupyter-book config sphinx docs/ --overwrite",
     "sphinx-build -b html docs/ docs/_build/html",
-    "freeze > docs/requirements.txt",
+    "uv pip freeze > docs/requirements.txt",
 ]
 
 docs = ["build", "serve"]