commit 2f7576cddcc043e1372dedfd8e12c8d314326384 Author: Kujiu Date: Thu May 6 13:32:18 2021 +0200 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..61b754a --- /dev/null +++ b/.gitignore @@ -0,0 +1,290 @@ +# ---> Node +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +lerna-debug.log* + +# Diagnostic reports (https://nodejs.org/api/report.html) +report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage +*.lcov + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Bower dependency directory (https://bower.io/) +bower_components + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (https://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules/ +jspm_packages/ + +# Snowpack dependency directory (https://snowpack.dev/) +web_modules/ + +# TypeScript cache +*.tsbuildinfo + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Microbundle cache +.rpt2_cache/ +.rts2_cache_cjs/ +.rts2_cache_es/ +.rts2_cache_umd/ + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variables file +.env +.env.test + +# parcel-bundler cache (https://parceljs.org/) +.cache +.parcel-cache + +# Next.js build output +.next +out + +# Nuxt.js build / generate output +.nuxt +dist + +# Gatsby files +.cache/ +# Comment in the public line in if your project uses Gatsby and not Next.js +# https://nextjs.org/blog/next-9-1#public-directory-support +# public + +# vuepress build output +.vuepress/dist + +# Serverless directories +.serverless/ + +# FuseBox cache +.fusebox/ + +# DynamoDB Local files +.dynamodb/ + +# TernJS port file +.tern-port + +# Stores VSCode versions used for testing VSCode extensions +.vscode-test + +# yarn v2 +.yarn/cache +.yarn/unplugged +.yarn/build-state.yml +.yarn/install-state.gz +.pnp.* + +# ---> Python +# 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 + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__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/ + +# ---> Vim +# Swap +[._]*.s[a-v][a-z] +!*.svg # comment out if you don't need vector files +[._]*.sw[a-p] +[._]s[a-rt-v][a-z] +[._]ss[a-gi-z] +[._]sw[a-p] + +# Session +Session.vim +Sessionx.vim + +# Temporary +.netrwhist +*~ +# Auto-generated tag files +tags +# Persistent undo +[._]*.un~ + +# ---> Vue +# gitignore template for Vue.js projects +# +# Recommended template: Node.gitignore + +# TODO: where does this rule come from? +docs/_book + +# TODO: where does this rule come from? +test/ + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c108cad --- /dev/null +++ b/LICENSE @@ -0,0 +1,305 @@ +European Union Public Licence v. 1.2 + +EUPL © the European Union 2007, 2016 + +This European Union Public Licence (the 'EUPL') applies to the Work (as defined +below) which is provided under the terms of this Licence. Any use of the Work, +other than as authorised under this Licence is prohibited (to the extent such +use is covered by a right of the copyright holder of the Work). + +The Work is provided under the terms of this Licence when the Licensor (as +defined below) has placed the following notice immediately following the copyright +notice for the Work: + + + + Licensed under the EUPL + + + +or has expressed by any other means his willingness to license under the EUPL. + + 1. Definitions + + In this Licence, the following terms have the following meaning: + + — 'The Licence': this Licence. + +— 'The Original Work': the work or software distributed or communicated by +the Licensor under this Licence, available as Source Code and also as Executable +Code as the case may be. + +— 'Derivative Works': the works or software that could be created by the Licensee, +based upon the Original Work or modifications thereof. This Licence does not +define the extent of modification or dependence on the Original Work required +in order to classify a work as a Derivative Work; this extent is determined +by copyright law applicable in the country mentioned in Article 15. + + — 'The Work': the Original Work or its Derivative Works. + +— 'The Source Code': the human-readable form of the Work which is the most +convenient for people to study and modify. + +— 'The Executable Code': any code which has generally been compiled and which +is meant to be interpreted by a computer as a program. + +— 'The Licensor': the natural or legal person that distributes or communicates +the Work under the Licence. + +— 'Contributor(s)': any natural or legal person who modifies the Work under +the Licence, or otherwise contributes to the creation of a Derivative Work. + +— 'The Licensee' or 'You': any natural or legal person who makes any usage +of the Work under the terms of the Licence. + +— 'Distribution' or 'Communication': any act of selling, giving, lending, +renting, distributing, communicating, transmitting, or otherwise making available, +online or offline, copies of the Work or providing access to its essential +functionalities at the disposal of any other natural or legal person. + + 2. Scope of the rights granted by the Licence + +The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, sublicensable +licence to do the following, for the duration of copyright vested in the Original +Work: + + — use the Work in any circumstance and for all usage, + + — reproduce the Work, + + — modify the Work, and make Derivative Works based upon the Work, + +— communicate to the public, including the right to make available or display +the Work or copies thereof to the public and perform publicly, as the case +may be, the Work, + + — distribute the Work or copies thereof, + + — lend and rent the Work or copies thereof, + + — sublicense rights in the Work or copies thereof. + +Those rights can be exercised on any media, supports and formats, whether +now known or later invented, as far as the applicable law permits so. + +In the countries where moral rights apply, the Licensor waives his right to +exercise his moral right to the extent allowed by law in order to make effective +the licence of the economic rights here above listed. + +The Licensor grants to the Licensee royalty-free, non-exclusive usage rights +to any patents held by the Licensor, to the extent necessary to make use of +the rights granted on the Work under this Licence. + + 3. Communication of the Source Code + +The Licensor may provide the Work either in its Source Code form, or as Executable +Code. If the Work is provided as Executable Code, the Licensor provides in +addition a machine-readable copy of the Source Code of the Work along with +each copy of the Work that the Licensor distributes or indicates, in a notice +following the copyright notice attached to the Work, a repository where the +Source Code is easily and freely accessible for as long as the Licensor continues +to distribute or communicate the Work. + + 4. Limitations on copyright + +Nothing in this Licence is intended to deprive the Licensee of the benefits +from any exception or limitation to the exclusive rights of the rights owners +in the Work, of the exhaustion of those rights or of other applicable limitations +thereto. + + 5. Obligations of the Licensee + +The grant of the rights mentioned above is subject to some restrictions and +obligations imposed on the Licensee. Those obligations are the following: + +Attribution right: The Licensee shall keep intact all copyright, patent or +trademarks notices and all notices that refer to the Licence and to the disclaimer +of warranties. The Licensee must include a copy of such notices and a copy +of the Licence with every copy of the Work he/she distributes or communicates. +The Licensee must cause any Derivative Work to carry prominent notices stating +that the Work has been modified and the date of modification. + +Copyleft clause: If the Licensee distributes or communicates copies of the +Original Works or Derivative Works, this Distribution or Communication will +be done under the terms of this Licence or of a later version of this Licence +unless the Original Work is expressly distributed only under this version +of the Licence — for example by communicating 'EUPL v. 1.2 only'. The Licensee +(becoming Licensor) cannot offer or impose any additional terms or conditions +on the Work or Derivative Work that alter or restrict the terms of the Licence. + +Compatibility clause: If the Licensee Distributes or Communicates Derivative +Works or copies thereof based upon both the Work and another work licensed +under a Compatible Licence, this Distribution or Communication can be done +under the terms of this Compatible Licence. For the sake of this clause, 'Compatible +Licence' refers to the licences listed in the appendix attached to this Licence. +Should the Licensee's obligations under the Compatible Licence conflict with +his/her obligations under this Licence, the obligations of the Compatible +Licence shall prevail. + +Provision of Source Code: When distributing or communicating copies of the +Work, the Licensee will provide a machine-readable copy of the Source Code +or indicate a repository where this Source will be easily and freely available +for as long as the Licensee continues to distribute or communicate the Work. + +Legal Protection: This Licence does not grant permission to use the trade +names, trademarks, service marks, or names of the Licensor, except as required +for reasonable and customary use in describing the origin of the Work and +reproducing the content of the copyright notice. + + 6. Chain of Authorship + +The original Licensor warrants that the copyright in the Original Work granted +hereunder is owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each Contributor warrants that the copyright in the modifications he/she brings +to the Work are owned by him/her or licensed to him/her and that he/she has +the power and authority to grant the Licence. + +Each time You accept the Licence, the original Licensor and subsequent Contributors +grant You a licence to their contributions to the Work, under the terms of +this Licence. + + 7. Disclaimer of Warranty + +The Work is a work in progress, which is continuously improved by numerous +Contributors. It is not a finished work and may therefore contain defects +or 'bugs' inherent to this type of development. + +For the above reason, the Work is provided under the Licence on an 'as is' +basis and without warranties of any kind concerning the Work, including without +limitation merchantability, fitness for a particular purpose, absence of defects +or errors, accuracy, non-infringement of intellectual property rights other +than copyright as stated in Article 6 of this Licence. + +This disclaimer of warranty is an essential part of the Licence and a condition +for the grant of any rights to the Work. + + 8. Disclaimer of Liability + +Except in the cases of wilful misconduct or damages directly caused to natural +persons, the Licensor will in no event be liable for any direct or indirect, +material or moral, damages of any kind, arising out of the Licence or of the +use of the Work, including without limitation, damages for loss of goodwill, +work stoppage, computer failure or malfunction, loss of data or any commercial +damage, even if the Licensor has been advised of the possibility of such damage. +However, the Licensor will be liable under statutory product liability laws +as far such laws apply to the Work. + + 9. Additional agreements + +While distributing the Work, You may choose to conclude an additional agreement, +defining obligations or services consistent with this Licence. However, if +accepting obligations, You may act only on your own behalf and on your sole +responsibility, not on behalf of the original Licensor or any other Contributor, +and only if You agree to indemnify, defend, and hold each Contributor harmless +for any liability incurred by, or claims asserted against such Contributor +by the fact You have accepted any warranty or additional liability. + + 10. Acceptance of the Licence + +The provisions of this Licence can be accepted by clicking on an icon 'I agree' +placed under the bottom of a window displaying the text of this Licence or +by affirming consent in any other similar way, in accordance with the rules +of applicable law. Clicking on that icon indicates your clear and irrevocable +acceptance of this Licence and all of its terms and conditions. + +Similarly, you irrevocably accept this Licence and all of its terms and conditions +by exercising any rights granted to You by Article 2 of this Licence, such +as the use of the Work, the creation by You of a Derivative Work or the Distribution +or Communication by You of the Work or copies thereof. + + 11. Information to the public + +In case of any Distribution or Communication of the Work by means of electronic +communication by You (for example, by offering to download the Work from a +remote location) the distribution channel or media (for example, a website) +must at least provide to the public the information requested by the applicable +law regarding the Licensor, the Licence and the way it may be accessible, +concluded, stored and reproduced by the Licensee. + + 12. Termination of the Licence + +The Licence and the rights granted hereunder will terminate automatically +upon any breach by the Licensee of the terms of the Licence. + +Such a termination will not terminate the licences of any person who has received +the Work from the Licensee under the Licence, provided such persons remain +in full compliance with the Licence. + + 13. Miscellaneous + +Without prejudice of Article 9 above, the Licence represents the complete +agreement between the Parties as to the Work. + +If any provision of the Licence is invalid or unenforceable under applicable +law, this will not affect the validity or enforceability of the Licence as +a whole. Such provision will be construed or reformed so as necessary to make +it valid and enforceable. + +The European Commission may publish other linguistic versions or new versions +of this Licence or updated versions of the Appendix, so far this is required +and reasonable, without reducing the scope of the rights granted by the Licence. +New versions of the Licence will be published with a unique version number. + +All linguistic versions of this Licence, approved by the European Commission, +have identical value. Parties can take advantage of the linguistic version +of their choice. + + 14. Jurisdiction + + Without prejudice to specific agreement between parties, + +— any litigation resulting from the interpretation of this License, arising +between the European Union institutions, bodies, offices or agencies, as a +Licensor, and any Licensee, will be subject to the jurisdiction of the Court +of Justice of the European Union, as laid down in article 272 of the Treaty +on the Functioning of the European Union, + +— any litigation arising between other parties and resulting from the interpretation +of this License, will be subject to the exclusive jurisdiction of the competent +court where the Licensor resides or conducts its primary business. + + 15. Applicable Law + + Without prejudice to specific agreement between parties, + +— this Licence shall be governed by the law of the European Union Member State +where the Licensor has his seat, resides or has his registered office, + +— this licence shall be governed by Belgian law if the Licensor has no seat, +residence or registered office inside a European Union Member State. + +Appendix + +'Compatible Licences' according to Article 5 EUPL are: + + — GNU General Public License (GPL) v. 2, v. 3 + + — GNU Affero General Public License (AGPL) v. 3 + + — Open Software License (OSL) v. 2.1, v. 3.0 + + — Eclipse Public License (EPL) v. 1.0 + + — CeCILL v. 2.0, v. 2.1 + + — Mozilla Public Licence (MPL) v. 2 + + — GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3 + +— Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for +works other than software + + — European Union Public Licence (EUPL) v. 1.1, v. 1.2 + +— Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong Reciprocity +(LiLiQ-R+). + +The European Commission may update this Appendix to later versions of the +above licences without producing a new version of the EUPL, as long as they +provide the rights granted in Article 2 of this Licence and protect the covered +Source Code from exclusive appropriation. + +All other changes or additions to this Appendix require the production of +a new EUPL version. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..0a1da44 --- /dev/null +++ b/README.rst @@ -0,0 +1,4 @@ +Nerv Tales Network +================== + +Authoring tool, library, accessibility, adaptation, copyright exemption, risk, pdca, documents and accounting management system. diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..56241b6 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = Contesetlgendesvol1 +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..2e3ac25 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build +set SPHINXPROJ=Contesetlgendesvol1 + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/docs/make.sh b/docs/make.sh new file mode 100755 index 0000000..2b29e3c --- /dev/null +++ b/docs/make.sh @@ -0,0 +1,5 @@ +#!/usr/bin/env bash + +make html +make -e SPHINXOPTS="-D language='en'" -e BUILDDIR=build/en html +make -e SPHINXOPTS="-D language='nl'" -e BUILDDIR=build/nl html diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..6f87152 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,18 @@ +sphinxcontrib-bibtex +sphinxcontrib-images +pybtex-apa-style +sphinxcontrib-actdiag +sphinxcontrib-blockdiag +sphinxcontrib-nwdiag +sphinxcontrib-seqdiag +sphinx-issues +sphinx-sitemap +sphinxemoji +sphinx-git +sphinx-intl +sphinxcontrib-bibtex +reportlab +ablog +sphinx-storymaker +sphinx-fasvg +sphinx-nervproject-theme diff --git a/docs/source/_static/favicon.ico b/docs/source/_static/favicon.ico new file mode 100644 index 0000000..83008c0 Binary files /dev/null and b/docs/source/_static/favicon.ico differ diff --git a/docs/source/_static/logo.png b/docs/source/_static/logo.png new file mode 100644 index 0000000..7fce2f3 Binary files /dev/null and b/docs/source/_static/logo.png differ diff --git a/docs/source/_static/logo.svg b/docs/source/_static/logo.svg new file mode 100644 index 0000000..b35c864 --- /dev/null +++ b/docs/source/_static/logo.svg @@ -0,0 +1,147 @@ + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + 2019 + + + Timothée Giet + + + + + + + + + + + + diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..956931c --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,260 @@ +# -*- coding: utf-8 -*- +import os + +project = 'Nerv Tales Network Documentation' +basename = 'nervtn' +project_uid = basename # ISBN, etc. +baseurl = 'https://tn.nerv-project.eu' +copyright = '2021, Nerv Project ASBL' +author = 'Nerv Project ASBL' +publisher = 'Nerv Project ASBL' +site_url = 'https://tn.nerv-project.eu/' +vcs_uri = "https://procrastinator.nerv-project.eu/" +use_bibtex = False +use_git = True +html_favicon = '_static/favicon.ico' +language = 'en' + +version = "0.1" +release = "0.1" + +if use_git: + from git import Repo + repository_name = 'nerv-project/' + repository_name += basename + + repo = Repo( + os.path.join( + os.path.dirname(os.path.realpath(__file__)), + '..', '..' + ) + ) + repo.config_reader() + + if not repo.head.is_detached: + version = repo.head.ref.name + release = version + ' [' + repo.commit().hexsha[:20] + ']' + + repository_uri = vcs_uri + repository_name + issues_uri = repository_uri + "/issues/{issue}" + issues_pr_uri = repository_uri + "/merge_requests/{pr}" + issues_commit_uri = repository_uri + "/commit/{commit}" + issues_user_uri = vcs_uri + "/{user}" + +extensions = [ + 'sphinxemoji.sphinxemoji', + 'sphinxcontrib.actdiag', + 'sphinxcontrib.blockdiag', + 'sphinxcontrib.nwdiag', + 'sphinxcontrib.seqdiag', + 'sphinxcontrib.images', + 'sphinx.ext.extlinks', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx_issues', + 'sphinx_sitemap', + 'sphinx_fasvg', +] + +if use_git: + extensions.append('sphinx_git') + +if use_bibtex: + extensions.append('sphinxcontrib.bibtex') + +locale_dirs = ['locale/'] + +images_config = { + "default_show_title": True, + "override_image_directive": True, + "show_caption": True, +} + +templates_path = ['_templates'] + +source_suffix = '.rst' +master_doc = 'index' + +exclude_patterns = [] +pygments_style = 'sphinx' + + +html_logo = '_static/logo.svg' +html_theme = 'nervproject' +html_theme_options = { + "logoalt": project, + "social": [ + ('solid', 'building', 'BCE 0756.741.342', 'https://kbopub.economie.fgov.be/kbopub/toonondernemingps.html?ondernemingsnummer=756741342'), + ('solid', 'receipt', 'TVA BE0756741342', 'https://kbopub.economie.fgov.be/kbopub/toonondernemingps.html?ondernemingsnummer=756741342'), + ('solid', 'books', 'KBR Éditeur 15066', 'https://www.kbr.be'), + ('brands', 'twitter', 'twitter', 'http://twitter.com/@nerv_project'), + ('solid', 'mug-hot', 'gitea', 'https://procrastinator.nerv-project.eu/nerv-project/nervtn'), + ('solid', 'hashtag', 'xmpp', 'xmpp:technique@clac.nerv-project.eu'), + ('regular', 'comments', 'movim', 'https://clac.nerv-project.eu/'), + ('solid', 'paragraph', 'gemini', 'gemini://tales.nerv-project.eu'), + ('solid', 'rss', 'rss', 'https://www.nerv-project.eu/blog/atom.xml'), + ], + 'external_languages': [ + # ('code', 'name', 'baseurl'), + ('en', 'en', 'https://tn.nerv-project.eu'), + ('fr', 'fr', 'https://fr.tn.nerv-project.eu'), + ('nl', 'nl', 'https://nl.tn.nerv-proect.eu'), + ], + "twitter_user": "nerv_project", + "fathom": { + 'url': '//casanabo.nerv-project.eu', + 'id': 'BJLEM', + }, + "license": { + 'type': 'EUPL-1.2', + 'text': 'EUPL-1.2', + 'subtype': '', + 'version': '', + 'url': 'https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12' + } +} +html_static_path = ['_static'] +html_sidebars = { + '**': [ + 'about.html', + 'postcard.html', 'util/sidetoc.html', + 'recentposts.html', 'tagcloud.html', + 'categories.html', 'archives.html', + 'social.html', + 'util/searchbox.html', + ], +} +html_baseurl = baseurl + +htmlhelp_basename = basename + +pyppeteer_pdf_options = { + 'printBackground': True, + 'format': 'A4', + 'margin': { + 'top': '0mm', + 'bottom': '0mm', + 'left': '0mm', + 'right': '0mm' + } +} + +latex_engine = 'xelatex' +latex_toplevel_sectioning = 'chapter' +latex_show_urls = 'footnote' +latex_elements = { + # 'figure_align': 'htbp', + # 'extraclassoptions': '', + 'papersize': 'a4paper', + 'pointsize': '12pt', + 'extraclassoptions': 'twoside', + 'fontpkg': r''' + \defaultfontfeatures{Ligatures=TeX} + \setmainfont{Luciole} + \setsansfont{Luciole} + ''' +} +latex_show_pagerefs = True +latex_documents = [ + (master_doc, basename + '.tex', project, + author, 'book'), +] + + +man_pages = [ + (master_doc, basename.lower(), project, [author], 1) +] + + +texinfo_documents = [ + (master_doc, basename, project, + author, basename, '', + 'Miscellaneous'), +] + + +epub_title = project +epub_author = author +epub_publisher = publisher +epub_copyright = copyright + +epub_identifier = project_uid +epub_uid = '' +epub_exclude_files = [ + 'index.xhtml', + 'search.xhtml', + 'blog.xhtml', + 'submit_success.xhtml', + 'contact.xhtml', + '403.xhtml', + '404.xhtml', + 'blog/archive.xhtml', + 'blog/category.xhtml', + 'blog/drafts.xhtml', + 'blog/author.xhtml', + 'blog/language.xhtml', + 'blog/location.xhtml', + 'blog/location/braine-lalleud.xhtml', + 'blog/language/francais.xhtml', + 'blog/author/kujiu.xhtml', + 'blog/2014.xhtml', + 'blog/2015.xhtml', + 'blog/2016.xhtml', + 'blog/2017.xhtml', + 'blog/2018.xhtml', + 'blog/2019.xhtml', + 'blog/2020.xhtml', + 'blog/2021.xhtml', + 'blog/2022.xhtml', + 'blog/2023.xhtml', + 'blog/2024.xhtml', + 'google82f190054a773ed9.xhtml', + 'nav.xhtml', +] +epub_theme = 'epub' +epub_show_urls = 'footnote' + +diag_antialias = True +diag_transparency = True +diag_html_image_format = "SVG" +diag_latex_image_format = "PDF" +diag_fontpath = os.path.dirname(os.path.realpath(__file__)) +diag_fontpath = os.path.join(diag_fontpath, '_static', 'biolinumrah.ttf') +diag_debug = False + +actdiag_antialias = diag_antialias +actdiag_transparency = diag_transparency +actdiag_html_image_format = diag_html_image_format +actdiag_latex_image_format = diag_latex_image_format +actdiag_fontpath = diag_fontpath +actdiag_debug = diag_debug + +blockdiag_antialias = diag_antialias +blockdiag_transparency = diag_transparency +blockdiag_html_image_format = diag_html_image_format +blockdiag_fontpath = diag_fontpath +blockdiag_latex_image_format = diag_latex_image_format +blockdiag_debug = diag_debug + +nwdiag_antialias = diag_antialias +nwdiag_transparency = diag_transparency +nwdiag_html_image_format = diag_html_image_format +nwdiag_latex_image_format = diag_latex_image_format +nwdiag_fontpath = diag_fontpath +nwdiag_debug = diag_debug + +seqdiag_antialias = diag_antialias +seqdiag_transparency = diag_transparency +seqdiag_html_image_format = diag_html_image_format +seqdiag_latex_image_format = diag_latex_image_format +seqdiag_fontpath = diag_fontpath +seqdiag_debug = diag_debug + + +if use_bibtex: + import pybtex.style.formatting + from pybtex.richtext import Text, Tag + + class NervPybtexStyle(pybtex.style.formatting.BaseStyle): + def format_article(self, entry): + return Text(Tag('em', entry.fields['key'])) diff --git a/docs/source/history.rst b/docs/source/history.rst new file mode 100644 index 0000000..d8f5e2e --- /dev/null +++ b/docs/source/history.rst @@ -0,0 +1,21 @@ +Document history +================ + +Current version +^^^^^^^^^^^^^^^ + +These informations are automatically generated +by git. + +.. git_commit_detail:: + :branch: + :commit: + :uncommitted: + :untracked: + :sha_length: 20 + +Versions log +^^^^^^^^^^^^ + +.. git_changelog:: + :revisions: 1000000 diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..4329e3c --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,7 @@ +Nerv Tales Network Documentation +################################ + +.. toctree:: + :maxdepth: 5 + + history diff --git a/docs/update-translation.sh b/docs/update-translation.sh new file mode 100755 index 0000000..1969359 --- /dev/null +++ b/docs/update-translation.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env bash + +make gettext +sphinx-intl update -p build/gettext -l fr -l nl