From d73a2f02a7f1bd672ac45b32219145e2137156a7 Mon Sep 17 00:00:00 2001 From: Cristian Le Date: Sun, 9 Jul 2023 21:37:34 +0200 Subject: [PATCH] Add basic sphinx/rtd framework Signed-off-by: Cristian Le --- .readthedocs.yaml | 13 +++++++++++++ README.md | 4 ++++ docs/conf.py | 26 ++++++++++++++++++++++++++ docs/index.md | 8 ++++++++ 4 files changed, 51 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 docs/conf.py create mode 100644 docs/index.md diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..3103d54 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,13 @@ +version: 2 + +python: + install: + - path: . + extra_requirements: + - docs +build: + os: ubuntu-22.04 + tools: + python: "3.11" +sphinx: + configuration: docs/conf.py diff --git a/README.md b/README.md index 0b84f1d..d418536 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ ## What is it? + + This is a C++ library for validating JSON documents based on a [JSON Schema](http://json-schema.org/) which itself should validate with [draft-7 of JSON Schema Validation](http://json-schema.org/schema). @@ -362,3 +364,5 @@ creating commits and making pull requests. $ pip install pre-commit $ pre-commit install ``` + + diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..2d8add9 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,26 @@ +project = 'Json Schema Validator' +copyright = '2023, Patrick Boettcher' +author = 'Patrick Boettcher' + +extensions = [ + "myst_parser", +] + +templates_path = [] +exclude_patterns = [ + 'build', + '_build', + 'Thumbs.db', + '.DS_Store', + "README.md", +] +source_suffix = [".md"] + + +html_theme = 'sphinx_rtd_theme' +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 0000000..2bd6894 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,8 @@ +# Json-Schema-Validator + +:::{include} ../README.md +--- +start-after: +end-before: +--- +:::