From 9353afec997696e837c0eedb9c8d0d5e48d4653c Mon Sep 17 00:00:00 2001 From: Cristian Le Date: Tue, 27 Jun 2023 09:38:20 +0200 Subject: [PATCH] Initial Sphinx support --- .readthedocs.yaml | 13 ++++ docs/.gitignore | 162 ++++++++++++++++++++++++++++++++++++++++++++ docs/conf.py | 29 ++++++++ docs/index.md | 14 ++++ docs/pyproject.toml | 25 +++++++ 5 files changed, 243 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 docs/.gitignore create mode 100644 docs/conf.py create mode 100644 docs/index.md create mode 100644 docs/pyproject.toml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..ffba68da --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,13 @@ +version: 2 + +python: + install: + - path: docs + extra_requirements: + - docs +build: + os: ubuntu-22.04 + tools: + python: "3.11" +sphinx: + configuration: docs/conf.py diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..287a2f0f --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,162 @@ +### Python template +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..8e161469 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,29 @@ +project = 'Catch2' +copyright = '2023, Martin Hořeňovský' +author = 'Martin Hořeňovský' + +extensions = [ + "myst_parser", + "sphinx_design", + "sphinx_togglebutton", + "breathe", +] + +templates_path = [] +exclude_patterns = [ + 'build', + '_build', + 'Thumbs.db', + '.DS_Store', + "Readme.md", +] +source_suffix = [".md"] + + +html_theme = 'furo' +#html_static_path = ['_static'] + +myst_enable_extensions = [ + "tasklist", + "colon_fence", +] diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..e2383a81 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,14 @@ +# Catch2 + +A modern, C++-native, test framework for unit-tests, TDD and BDD - using C++14, C++17 and later. + + +:::{toctree} +--- +maxdepth: 2 +titlesonly: true +caption: Contents +glob: true +--- +/* +::: diff --git a/docs/pyproject.toml b/docs/pyproject.toml new file mode 100644 index 00000000..641cc5b3 --- /dev/null +++ b/docs/pyproject.toml @@ -0,0 +1,25 @@ +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" + +[project] +name = "Catch2-dev" +version = "0.0.0" +description = "Development environment for Catch2" + + +[project.optional-dependencies] +docs = [ + "sphinx >= 6.0", + "furo", + "sphinx-design", + "sphinx-togglebutton", + "myst-parser", + "breathe", +] +dev = [ + "pre-commit", +] + +[tool.setuptools] +packages = []