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 659444e commit 40669b8
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 13 deletions.
39 changes: 27 additions & 12 deletions .github/workflows/sphinx_doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,35 @@ 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@v2

- name: Sphinx Build
# You may pin to the exact commit or the version.
uses: ammaraskar/sphinx-action@master
- uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v3
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'
python-version: '3.x'

- name: Install Sphinx & Dependencies
run: pip install sphinx_rtd_theme nbsphinx sphinxcontrib.bibtex sphinxcontrib.programoutput sphinxcontrib.contentui autodoc MarkupSafe==2.0.1

-name: Change folder
run: cd doc

-name: Sphinx Build
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: Instala
# # - name: Instala
# run: |
# pip install sphinx_rtd_theme nbsphinx sphinxcontrib.bibtex
# pip install sphinxcontrib.programoutput sphinxcontrib.contentui
Expand Down
1 change: 0 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,3 @@

utils.rst


0 comments on commit 40669b8

Please sign in to comment.