Skip to content

Commit 672cbc1

Browse files
authored
1243 Deactivate old github pages documentation (#1244)
With the new documentation, deactivate old github pages documentation
1 parent 7be189b commit 672cbc1

File tree

5 files changed

+2
-391
lines changed

5 files changed

+2
-391
lines changed

.github/actions/test-docs/action.yml

Lines changed: 0 additions & 21 deletions
This file was deleted.

.github/workflows/main.yml

Lines changed: 0 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -316,13 +316,6 @@ jobs:
316316
package: surrogatemodel
317317
coverage: ON
318318

319-
test-docs:
320-
if: github.event.pull_request.draft == false
321-
runs-on: ubuntu-latest
322-
steps:
323-
- uses: actions/checkout@v4
324-
- uses: ./.github/actions/test-docs
325-
326319
codecov:
327320
if: github.event.pull_request.draft == false
328321
needs: merge-test-artifacts
@@ -348,71 +341,3 @@ jobs:
348341
directory: ./coverage_python
349342
files: ./coverage_python/**,./coverage.info
350343
verbose: true
351-
352-
pages:
353-
if: github.event.pull_request.draft == false
354-
permissions:
355-
contents: write
356-
needs: [test-docs, merge-test-artifacts]
357-
runs-on: ubuntu-latest
358-
steps:
359-
- uses: actions/checkout@v4
360-
- name: Install dependencies
361-
run: |
362-
sudo apt-get -qq update
363-
sudo apt-get -qq -y install git
364-
- name: Download python coverage report
365-
uses: actions/download-artifact@v4
366-
with:
367-
name: test-py-coverage-reports-surrogatemodel
368-
- name: Download cpp coverage report
369-
uses: actions/download-artifact@v4
370-
with:
371-
name: test-cpp-coverage-reports
372-
- name: Download pylint report
373-
#if an error occurs here, the pylint report was not built, probably manually trigger epidata-ci
374-
uses: dawidd6/action-download-artifact@v6
375-
with:
376-
github_token: ${{secrets.GITHUB_TOKEN}}
377-
workflow: epidata_main.yml
378-
name: pylint-report-epidata
379-
path: pycode/build_pylint
380-
- name: Download documentation
381-
uses: actions/download-artifact@v4
382-
with:
383-
name: documentation
384-
path: docs/html
385-
- name: Prepare basic Pages sites
386-
run: |
387-
mkdir -p public
388-
cp docs/style.css public/style.css
389-
cp docs/index.html public/index.html
390-
- name: Prepare pylint reports
391-
run: |
392-
mkdir -p public/pylint
393-
cp pycode/build_pylint/pylint.html public/pylint/index.html
394-
- name: Prepare documentation
395-
run: |
396-
mkdir -p public/documentation
397-
cp -r docs/html/* public/documentation
398-
- name: Prepare coverage reports
399-
run: |
400-
mkdir -p public/coverage
401-
mkdir -p public/coverage/cpp
402-
mkdir -p public/coverage/python
403-
cp -r coverage_python/* public/coverage/python/
404-
cp -r coverage/* public/coverage/cpp/
405-
- name: Upload pages as artifact
406-
uses: actions/upload-artifact@v4
407-
if: github.event_name == 'pull_request' && github.ref != 'refs/heads/main'
408-
with:
409-
name: pages
410-
path: public
411-
if-no-files-found: error
412-
retention-days: 1
413-
- name: Deploy to gh-pages branch
414-
uses: peaceiris/actions-gh-pages@v3
415-
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
416-
with:
417-
github_token: ${{ secrets.GITHUB_TOKEN }}
418-
publish_dir: ./public

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
MEmilio Documentation
22
===============================
3-
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.
3+
With every merged pull request, the online documentation gets updated at: [https://memilio.readthedocs.io/en/latest/](https://memilio.readthedocs.io/en/latest/).
44

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

77
How to create the documentation:
88
---------------------------------

docs/index.html

Lines changed: 0 additions & 146 deletions
This file was deleted.

0 commit comments

Comments
 (0)