Skip to content
Snippets Groups Projects
Commit 22d37959 authored by Martin Teichmann's avatar Martin Teichmann
Browse files

start using sphinx napoleon for documentation

parent f16c8748
No related branches found
No related tags found
No related merge requests found
Pipeline #95527 passed
......@@ -4,11 +4,14 @@ test:
- python3 -m ebpfcat.ebpf_test -v Tests && python3 -m ebpfcat.ethercat_test -v
docs:
image: tk0miya/sphinx-html
image: sphinxdoc/sphinx
script:
- apt-get update
- apt-get install -y openssh-client
- pip3 install sphinx-autoapi
- python3 setup.py install --user
- sphinx-build -b html -d _build/doctrees . _build/html
- eval $(ssh-agent)
- echo "$SSHKEY" | ssh-add -
- ssh -o UserKnownHostsFile=known_hosts wp86team@exflqr30526 "./doc-prepare ec_$CI_COMMIT_REF_NAME"
- scp -o UserKnownHostsFile=known_hosts -r _build/html wp86team@exflqr30526:html/ec_$CI_COMMIT_REF_NAME
- ssh -o UserKnownHostsFile=known_hosts wp86team@exflqr30526 "./doc-prepare ebpfcat/$CI_COMMIT_REF_NAME"
- scp -o UserKnownHostsFile=known_hosts -r _build/html wp86team@exflqr30526:html/ebpfcat/$CI_COMMIT_REF_NAME
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
]
templates_path = ['_templates']
......@@ -13,10 +14,10 @@ author = 'Martin Teichmann'
release = "0.1"
version = "0.1.0"
language = None
language = 'en'
exclude_patterns = ['_build']
pygments_style = 'sphinx'
todo_include_todos = False
html_theme = 'alabaster'
html_theme = 'classic'
html_static_path = ['_static']
htmlhelp_basename = 'EBPFCat'
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment