Added documentation config

This commit is contained in:
Vladimir Magamedov 2017-11-30 14:53:09 +02:00
parent dfd6688cc8
commit 68bfaf2024
4 changed files with 46 additions and 1 deletions

7
docs/changelog/index.rst Normal file
View File

@ -0,0 +1,7 @@
Changelog
=========
0.1.0
~~~~~
- Initial release

14
docs/conf.py Normal file
View File

@ -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 = []

9
docs/index.rst Normal file
View File

@ -0,0 +1,9 @@
.. include:: ../README.rst
User's Guide
~~~~~~~~~~~~
.. toctree::
:maxdepth: 2
changelog/index

17
pi.yaml
View File

@ -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