diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/code_of_conduct.md | 4 | ||||
| -rw-r--r-- | docs/conf.py | 4 | ||||
| -rw-r--r-- | docs/contributing.md | 4 | ||||
| -rw-r--r-- | docs/index.md | 10 | ||||
| -rw-r--r-- | docs/index.rst | 20 | ||||
| -rw-r--r-- | docs/license.md | 6 | ||||
| -rw-r--r-- | docs/readme.md | 4 |
7 files changed, 30 insertions, 22 deletions
diff --git a/docs/code_of_conduct.md b/docs/code_of_conduct.md new file mode 100644 index 00000000..74e5474b --- /dev/null +++ b/docs/code_of_conduct.md @@ -0,0 +1,4 @@ +```{include} ../CODE_OF_CONDUCT.md +:relative-docs: docs/ +:relative-images: +``` diff --git a/docs/conf.py b/docs/conf.py index 3617f9fc..23392e9c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -31,7 +31,7 @@ release = "0.0.4" # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions: List[str] = [] +extensions: List[str] = ["myst_parser"] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] @@ -47,7 +47,7 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = "alabaster" +html_theme = "sphinx_book_theme" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 00000000..fc1b2138 --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,4 @@ +```{include} ../CONTRIBUTING.md +:relative-docs: docs/ +:relative-images: +``` diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..4554a3b2 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,10 @@ +# Sec-certs documentation + +```{toctree} +:maxdepth: 2 +readme.md +contributing.md +code_of_conduct.md +license.md +``` + diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 9e16d741..00000000 --- a/docs/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. sec-certs documentation master file, created by - sphinx-quickstart on Sun Apr 24 20:56:46 2022. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to sec-certs's documentation! -===================================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 00000000..4f6e8060 --- /dev/null +++ b/docs/license.md @@ -0,0 +1,6 @@ +# License + +```{include} ../LICENSE +:relative-docs: docs/ +:relative-images: +``` diff --git a/docs/readme.md b/docs/readme.md new file mode 100644 index 00000000..2cb706b3 --- /dev/null +++ b/docs/readme.md @@ -0,0 +1,4 @@ +```{include} ../README.md +:relative-docs: docs/ +:relative-images: +``` |