From 68bfaf2024ee50c26d94463835c39e52c055f51c Mon Sep 17 00:00:00 2001 From: Vladimir Magamedov Date: Thu, 30 Nov 2017 14:53:09 +0200 Subject: [PATCH] Added documentation config --- docs/changelog/index.rst | 7 +++++++ docs/conf.py | 14 ++++++++++++++ docs/index.rst | 9 +++++++++ pi.yaml | 17 ++++++++++++++++- 4 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 docs/changelog/index.rst create mode 100644 docs/conf.py create mode 100644 docs/index.rst diff --git a/docs/changelog/index.rst b/docs/changelog/index.rst new file mode 100644 index 0000000..90fc225 --- /dev/null +++ b/docs/changelog/index.rst @@ -0,0 +1,7 @@ +Changelog +========= + +0.1.0 +~~~~~ + + - Initial release diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..3a9bbaa --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,14 @@ +source_suffix = '.rst' +master_doc = 'index' + +project = 'grpclib' +copyright = '2017, Vladimir Magamedov' +author = 'Vladimir Magamedov' + +version = 'dev' +release = 'dev' + +templates_path = [] + +html_theme = 'sphinx_rtd_theme' +html_static_path = [] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..19f57e3 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,9 @@ +.. include:: ../README.rst + +User's Guide +~~~~~~~~~~~~ + +.. toctree:: + :maxdepth: 2 + + changelog/index diff --git a/pi.yaml b/pi.yaml index 82ab392..b83ba11 100644 --- a/pi.yaml +++ b/pi.yaml @@ -11,6 +11,17 @@ - async-timeout==2.0.0 - multidict==3.3.0 +- !Image + name: docs + from: env36 + repository: localhost/grpclib/docs + tasks: + - run: apk add --no-cache ca-certificates + - run: update-ca-certificates + - run: pip3 install --no-cache-dir {{packages|join(" ")}} + packages: + - sphinx==1.6.5 + - sphinx_rtd_theme==0.2.5b1 - !Command name: server @@ -22,10 +33,14 @@ ports: - !Expose { port: 50051, as: 50051 } - - !Command name: client image: env36 run: python3 -m helloworld.client environ: PYTHONPATH: example + +- !Command + name: build docs + image: docs + run: sphinx-build -b html docs build