From 659444e5a8fbcaea21500f7d837c492d02a789cc Mon Sep 17 00:00:00 2001 From: gonfeco Date: Wed, 16 Oct 2024 09:17:30 +0200 Subject: [PATCH] Test doc --- .github/workflows/sphinx_doc.yml | 50 ++++++++++++++++++-------------- doc/index.rst | 1 + 2 files changed, 30 insertions(+), 21 deletions(-) diff --git a/.github/workflows/sphinx_doc.yml b/.github/workflows/sphinx_doc.yml index cd53547..7d9e88c 100644 --- a/.github/workflows/sphinx_doc.yml +++ b/.github/workflows/sphinx_doc.yml @@ -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 diff --git a/doc/index.rst b/doc/index.rst index 8bbeb90..c970b20 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -83,3 +83,4 @@ utils.rst +