Skip to content

Commit

Permalink
Update doc pipeline, build and deploy pdf doc
Browse files Browse the repository at this point in the history
  • Loading branch information
rosericazondekon committed Apr 28, 2023
1 parent 84ee828 commit 69f6444
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 1 deletion.
15 changes: 14 additions & 1 deletion .github/workflows/gh-pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,17 @@ jobs:
with:
publish_branch: gh-pages
github_token: ${{ secrets.API_TOKEN_GITHUB }}
publish_dir: docs/_build/html/
publish_dir: docs/_build/html/

# Deploy Package build
- name: Deploy PDF doc
run: |
mkdir public
docs/make latexpdf
cp -r docs/_build/latex/pynssp.pdf public
# Upload Pipeline Artifact
- name: Upload PDF doc
uses: actions/upload-artifact@v2
with:
path: public
46 changes: 46 additions & 0 deletions docs/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{%- extends "!layout.html" %}

{%- block footer %}
{%- if not READTHEDOCS %}
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="{{ _('Versions') }}">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>{{ _('Versions') }}</dt>
{%- if test_versions %}
{%- for version in test_versions %}
<dd><a href="#">{{ version }}</a></dd>
{%- endfor %}
{%- else %}
<dd><a href="#">latest</a></dd>
<dd><a href="#">0.1.0</a></dd>
<!-- <dd><a href="#">1.1</a></dd> -->
{%- endif %}
</dl>
<dl>
<dt>{{ _('Downloads') }}</dt>
<dd><a href="#">PDF</a></dd>
<dd><a href="#">ePub</a></dd>
<!-- <dd><a href="#">HTML</a></dd> -->
</dl>
<dl>
<dt>{{ _('On this Documentation') }}</dt>
<dd>
<a href="https://github.com/CDCgov/pynssp/tree/master/docs">{{ _('doc source') }}</a>
</dd>
<dd>
<a href="https://github.com/CDCgov/pynssp/tree/gh-pages">{{ _('build source') }}</a>
</dd>
</dl>
<!-- <dl>
<dt>Debug</dt>
<dd><a href="#" data-toggle="rst-debug-badge">Swap badge position</a></dd>
</dl> -->
</div>
</div>
{%- endif %}
{%- endblock %}
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@
'Gbedegnon Roseric Azondekon', 'manual'),
]

latex_engine = 'pdflatex'

# -- Options for manual page output ------------------------------------

Expand Down

0 comments on commit 69f6444

Please sign in to comment.