Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions .github/actions/test-docs/action.yml

This file was deleted.

75 changes: 0 additions & 75 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -316,13 +316,6 @@ jobs:
package: surrogatemodel
coverage: ON

test-docs:
if: github.event.pull_request.draft == false
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: ./.github/actions/test-docs

codecov:
if: github.event.pull_request.draft == false
needs: merge-test-artifacts
Expand All @@ -348,71 +341,3 @@ jobs:
directory: ./coverage_python
files: ./coverage_python/**,./coverage.info
verbose: true

pages:
if: github.event.pull_request.draft == false
permissions:
contents: write
needs: [test-docs, merge-test-artifacts]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install dependencies
run: |
sudo apt-get -qq update
sudo apt-get -qq -y install git
- name: Download python coverage report
uses: actions/download-artifact@v4
with:
name: test-py-coverage-reports-surrogatemodel
- name: Download cpp coverage report
uses: actions/download-artifact@v4
with:
name: test-cpp-coverage-reports
- name: Download pylint report
#if an error occurs here, the pylint report was not built, probably manually trigger epidata-ci
uses: dawidd6/action-download-artifact@v6
with:
github_token: ${{secrets.GITHUB_TOKEN}}
workflow: epidata_main.yml
name: pylint-report-epidata
path: pycode/build_pylint
- name: Download documentation
uses: actions/download-artifact@v4
with:
name: documentation
path: docs/html
- name: Prepare basic Pages sites
run: |
mkdir -p public
cp docs/style.css public/style.css
cp docs/index.html public/index.html
- name: Prepare pylint reports
run: |
mkdir -p public/pylint
cp pycode/build_pylint/pylint.html public/pylint/index.html
- name: Prepare documentation
run: |
mkdir -p public/documentation
cp -r docs/html/* public/documentation
- name: Prepare coverage reports
run: |
mkdir -p public/coverage
mkdir -p public/coverage/cpp
mkdir -p public/coverage/python
cp -r coverage_python/* public/coverage/python/
cp -r coverage/* public/coverage/cpp/
- name: Upload pages as artifact
uses: actions/upload-artifact@v4
if: github.event_name == 'pull_request' && github.ref != 'refs/heads/main'
with:
name: pages
path: public
if-no-files-found: error
retention-days: 1
- name: Deploy to gh-pages branch
uses: peaceiris/actions-gh-pages@v3
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./public
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
MEmilio Documentation
===============================
The MEmilio documentation is created by [doxygen](https://www.doxygen.nl/). The documentation of the main branch is automatically deployed to https://scicompmod.github.io/memilio/documentation/index.html by the continuous integration process.
With every merged pull request, the online documentation gets updated at: [https://memilio.readthedocs.io/en/latest/](https://memilio.readthedocs.io/en/latest/).

In order to create the MEmilio documentation locally, follow the procedure below.
A MEmilio documentation can also be created locally with [doxygen](https://www.doxygen.nl/). In order to do so, follow the procedure below.

How to create the documentation:
---------------------------------
Expand Down
146 changes: 0 additions & 146 deletions docs/index.html

This file was deleted.

Loading
Loading