diff --git a/.gitignore b/.gitignore index b6849285..bea90d3f 100644 --- a/.gitignore +++ b/.gitignore @@ -11,3 +11,6 @@ Thumbs.db # Swap files *.swp + +# Sphinx +build \ No newline at end of file diff --git a/README.md b/README.md index f4166051..144b1bf0 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,24 @@ Furthermore, the project uses branches and tags in the following way: Feel free to submit [Pull Requests and to file Issues](CONTRIBUTING.md). +The Standard's website (https://yml.publiccode.tools) is built using the Python Sphinx package. + +### Prerequisites +- Python 3 + +### Install dependencies + +```console +pip install -r requirements.txt +``` + +### Local development process +`spinx-build` can be used to compile all source file to static html files. Run this command to generate the website: + +```console +sphinx-build docs/standard build -c . +``` + ## Licence Licenced under the [CC0-1.0](LICENSE). diff --git a/_templates/layout.html b/_templates/layout.html new file mode 100644 index 00000000..ba70d1a5 --- /dev/null +++ b/_templates/layout.html @@ -0,0 +1,31 @@ +{% extends '!layout.html' %} + +{% block footer %} + + + +{% endblock %} + +{% block header %} + + + +{% endblock %} \ No newline at end of file diff --git a/conf.py b/conf.py index d9a99252..a5bec399 100644 --- a/conf.py +++ b/conf.py @@ -15,6 +15,8 @@ html_theme = "press" +templates_path = ['_templates'] + extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.viewcode',