forked from numerique-gouv/b3desk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request numerique-gouv#68 from yaal-coop/issue-10-doc
Squelette de documentation
- Loading branch information
Showing
9 changed files
with
1,127 additions
and
618 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # .readthedocs.yaml | ||
| # Read the Docs configuration file | ||
| # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
|
||
| # Required | ||
| version: 2 | ||
|
|
||
| # Set the OS, Python version and other tools you might need | ||
| build: | ||
| os: ubuntu-22.04 | ||
| tools: | ||
| python: "3.12" | ||
| # You can also specify other tool versions: | ||
| # nodejs: "19" | ||
| # rust: "1.64" | ||
| # golang: "1.19" | ||
|
|
||
| # Build documentation in the "docs/" directory with Sphinx | ||
| sphinx: | ||
| configuration: documentation/conf.py | ||
|
|
||
| # Optionally build your docs in additional formats such as PDF and ePub | ||
| # formats: | ||
| # - epub | ||
|
|
||
| # Optional but recommended, declare the Python requirements required | ||
| # to build your documentation | ||
| # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html | ||
| python: | ||
| install: | ||
| - requirements: web/requirements.doc.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| #!/usr/bin/env python3 | ||
| import datetime | ||
| import os | ||
| import sys | ||
|
|
||
| sys.path.insert(0, os.path.abspath("..")) | ||
| sys.path.insert(0, os.path.abspath("../web")) | ||
| sys.path.insert(0, os.path.abspath("../web/flaskr")) | ||
|
|
||
|
|
||
| # -- General configuration ------------------------------------------------ | ||
|
|
||
|
|
||
| extensions = [ | ||
| "myst_parser", | ||
| "sphinx.ext.autodoc", | ||
| "sphinx.ext.doctest", | ||
| "sphinx.ext.graphviz", | ||
| "sphinx.ext.intersphinx", | ||
| "sphinx.ext.todo", | ||
| "sphinx.ext.viewcode", | ||
| ] | ||
|
|
||
| templates_path = ["_templates"] | ||
| source_suffix = { | ||
| ".rst": "restructuredtext", | ||
| ".md": "markdown", | ||
| } | ||
| master_doc = "index" | ||
| project = "flaskr" | ||
| year = datetime.datetime.now().strftime("%Y") | ||
| copyright = f"{year}, Ministère de l'Éducation Nationale" | ||
| author = "Ministère de l'Éducation Nationale" | ||
|
|
||
| release = "1.1.0" # metadata.version("flaskr") | ||
| version = "%s.%s" % tuple(map(int, release.split(".")[:2])) | ||
| language = "fr" | ||
| exclude_patterns = [] | ||
| pygments_style = "sphinx" | ||
| todo_include_todos = False | ||
|
|
||
| intersphinx_mapping = { | ||
| "python": ("https://docs.python.org/3", None), | ||
| } | ||
|
|
||
| # -- Options for HTML output ---------------------------------------------- | ||
|
|
||
| html_theme = "sphinx_rtd_theme" | ||
| html_static_path = [] | ||
|
|
||
|
|
||
| # -- Options for HTMLHelp output ------------------------------------------ | ||
|
|
||
| htmlhelp_basename = "b3deskdoc" | ||
| html_logo = "" | ||
|
|
||
|
|
||
| # -- Options for LaTeX output --------------------------------------------- | ||
|
|
||
| latex_elements = {} | ||
| latex_documents = [ | ||
| ( | ||
| master_doc, | ||
| "b3desk.tex", | ||
| "B3Desk Documentation", | ||
| "Ministère de l’Éducation Nationale", | ||
| "manual", | ||
| ) | ||
| ] | ||
|
|
||
| # -- Options for manual page output --------------------------------------- | ||
|
|
||
| man_pages = [(master_doc, "b3desk", "B3Desk Documentation", [author], 1)] | ||
|
|
||
| # -- Options for Texinfo output ------------------------------------------- | ||
|
|
||
| texinfo_documents = [ | ||
| ( | ||
| master_doc, | ||
| "b3desk", | ||
| "B3Desk Documentation", | ||
| author, | ||
| "B3Desk", | ||
| "BBB frontend by the French Ministry of Education.", | ||
| "Miscellaneous", | ||
| ) | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| B3Desk | ||
| ====== | ||
|
|
||
| Frontend Big Blue Button du Ministère de l’Éducation Nationale. | ||
|
|
||
| Table des matières | ||
| ================== | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
|
|
||
| dockerPersistence | ||
| meetingFiles | ||
| pullRequestValidation | ||
| translation | ||
|
|
||
| Index et tables | ||
| =============== | ||
|
|
||
| * :ref:`genindex` | ||
| * :ref:`modindex` | ||
| * :ref:`search` |
Oops, something went wrong.