forked from Wavyzz/py-healthchecks.io
100% coverage of checks schemas
This commit is contained in:
1
docs/codeofconduct.rst
Normal file
1
docs/codeofconduct.rst
Normal file
@@ -0,0 +1 @@
|
||||
.. include:: ../CODE_OF_CONDUCT.rst
|
||||
14
docs/conf.py
Normal file
14
docs/conf.py
Normal file
@@ -0,0 +1,14 @@
|
||||
"""Sphinx configuration."""
|
||||
from datetime import datetime
|
||||
|
||||
|
||||
project = "Py Healthchecks.Io"
|
||||
author = "Andrew Herrington"
|
||||
copyright = f"{datetime.now().year}, {author}"
|
||||
extensions = [
|
||||
"sphinx.ext.autodoc",
|
||||
"sphinx.ext.napoleon",
|
||||
"sphinx_click",
|
||||
]
|
||||
autodoc_typehints = "description"
|
||||
html_theme = "furo"
|
||||
4
docs/contributing.rst
Normal file
4
docs/contributing.rst
Normal file
@@ -0,0 +1,4 @@
|
||||
.. include:: ../CONTRIBUTING.rst
|
||||
:end-before: github-only
|
||||
|
||||
.. _Code of Conduct: codeofconduct.html
|
||||
16
docs/index.rst
Normal file
16
docs/index.rst
Normal file
@@ -0,0 +1,16 @@
|
||||
.. include:: ../README.rst
|
||||
:end-before: github-only
|
||||
|
||||
.. _Contributor Guide: contributing.html
|
||||
.. _Usage: usage.html
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 1
|
||||
|
||||
usage
|
||||
reference
|
||||
contributing
|
||||
Code of Conduct <codeofconduct>
|
||||
License <license>
|
||||
Changelog <https://github.com/andrewthetechie/py-healthchecks.io/releases>
|
||||
1
docs/license.rst
Normal file
1
docs/license.rst
Normal file
@@ -0,0 +1 @@
|
||||
.. include:: ../LICENSE.rst
|
||||
9
docs/reference.rst
Normal file
9
docs/reference.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
Reference
|
||||
=========
|
||||
|
||||
|
||||
py_healthchecks.io
|
||||
------------------
|
||||
|
||||
.. automodule:: healthchecks_io
|
||||
:members:
|
||||
3
docs/requirements.txt
Normal file
3
docs/requirements.txt
Normal file
@@ -0,0 +1,3 @@
|
||||
furo==2021.11.23
|
||||
sphinx==4.3.1
|
||||
sphinx-click==3.0.2
|
||||
2
docs/usage.rst
Normal file
2
docs/usage.rst
Normal file
@@ -0,0 +1,2 @@
|
||||
Usage
|
||||
=====
|
||||
Reference in New Issue
Block a user