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