Skip to content

Commit

Permalink
Test doc
Browse files Browse the repository at this point in the history
  • Loading branch information
gonfeco committed Oct 16, 2024
1 parent f171b56 commit 659444e
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 21 deletions.
50 changes: 29 additions & 21 deletions .github/workflows/sphinx_doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,37 @@ jobs:
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
#Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v4
- uses: actions/checkout@v2

- name: Sphinx Build
# You may pin to the exact commit or the version.
uses: ammaraskar/sphinx-action@master
with:
# The folder containing your sphinx docs.
docs-folder: 'doc/' # default is docs/
# The command used to build your documentation.
#build-command: 'sphinx-build -b html . _build' # optional, default is make html
# Run before the build command, you can use this to install system level dependencies, for example with "apt-get update -y && apt-get install -y perl"
build-command: 'python -m pip install sphinx_rtd_theme nbsphinx sphinxcontrib.bibtex sphinxcontrib.programoutput sphinxcontrib.contentui autodoc MarkupSafe==2.0.1'

#- name: Instala
# run: |
# pip install sphinx_rtd_theme nbsphinx sphinxcontrib.bibtex
# pip install sphinxcontrib.programoutput sphinxcontrib.contentui
# pip install autodoc MarkupSafe==2.0.1
# cd doc
# sphinx-build -b html . _build
# - name: Instala
# run: |
# pip install sphinx_rtd_theme nbsphinx sphinxcontrib.bibtex
# pip install sphinxcontrib.programoutput sphinxcontrib.contentui
# pip install autodoc MarkupSafe==2.0.1
# cd doc
# sphinx-build -b html . _build

- name: Sphinx Build
#You may pin to the exact commit or the version.
uses: ammaraskar/sphinx-action@master
with:
# The folder containing your sphinx docs.
docs-folder: 'doc/' # default is docs/
# The command used to build your documentation.
#build-command: 'sphinx-build -b html . _build' # optional, default is make html
# Run before the build command, you can use this to install system level dependencies, for example with "apt-get update -y && apt-get install -y perl"
build-command: 'python -m pip install sphinx_rtd_theme nbsphinx sphinxcontrib.bibtex sphinxcontrib.programoutput sphinxcontrib.contentui autodoc MarkupSafe==2.0.1'
- name: Sphinx
run : |
sphinx-build -b html . _build
# - name: Sphinx Build
# #You may pin to the exact commit or the version.
# uses: ammaraskar/sphinx-action@master
# with:
# # The folder containing your sphinx docs.
# docs-folder: 'doc/' # default is docs/
# # The command used to build your documentation.
# build-command: 'sphinx-build -b html . _build ' # optional, default is make html
# # Run before the build command, you can use this to install system level dependencies, for example with "apt-get update -y && apt-get install -y perl"
# pre-build-command: 'python -m pip install sphinx_rtd_theme nbsphinx sphinxcontrib.bibtex sphinxcontrib.programoutput sphinxcontrib.contentui autodoc MarkupSafe==2.0.1'

- name: Upload a Build Artifact
uses: actions/upload-artifact@v4
Expand Down
1 change: 1 addition & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,4 @@

utils.rst


0 comments on commit 659444e

Please sign in to comment.