Add basic sphinx/rtd framework

Signed-off-by: Cristian Le <git@lecris.dev>
This commit is contained in:
Cristian Le 2023-07-09 21:37:34 +02:00
parent e306d7905e
commit d73a2f02a7
Failed to extract signature
4 changed files with 51 additions and 0 deletions

13
.readthedocs.yaml Normal file
View File

@ -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

View File

@ -2,6 +2,8 @@
## What is it?
<!-- SHINX-START -->
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
```
<!-- SHINX-END -->

26
docs/conf.py Normal file
View File

@ -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",
]

8
docs/index.md Normal file
View File

@ -0,0 +1,8 @@
# Json-Schema-Validator
:::{include} ../README.md
---
start-after: <!-- SHINX-START -->
end-before: <!-- SHINX-END -->
---
:::