Thanks to visit codestin.com
Credit goes to github.com

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
14 changes: 4 additions & 10 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,12 @@ jobs:
with:
submodules: true
lfs: true
- name: Install bundler
run: sudo apt update -y && sudo apt install -y bundler
- name: Restore cache
uses: actions/cache@v2
- uses: ruby/setup-ruby@v1
with:
path: vendor/bundle
key: ${{ runner.os }}-new-gems-${{ hashFiles('**/Gemfile.lock') }}
- name: Install dependencies
run: |
bundle config path "$PWD/vendor/bundle"
bundle install
bundler-cache: true
- name: Build site
env:
JEKYLL_ENV: production
run: bundle exec jekyll build
- name: Upload site
uses: actions/upload-artifact@v2
Expand Down
58 changes: 49 additions & 9 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,59 @@ jobs:
build-deploy:
runs-on: ubuntu-20.04
steps:
- name: Checkout repository
- name: Checkout website
uses: actions/checkout@v2
with:
submodules: true
lfs: true
- name: Restore cache
uses: actions/cache@v2
path: website

- name: Fetch - precice develop
uses: actions/checkout@v2
with:
path: vendor/bundle
key: ${{ runner.os }}-new-gems-${{ hashFiles('**/Gemfile.lock') }}
- name: Build and publish
uses: helaili/[email protected]
repository: precice/precice
ref: develop
path: develop

- name: Fetch - precice master
uses: actions/checkout@v2
with:
repository: precice/precice
ref: master
path: master

- name: Install dependencies
run: |
sudo apt-get -yyq install doxygen graphviz

- name: Setup ruby
uses: ruby/setup-ruby@v1
with:
target_branch: 'gh-pages'
bundler-cache: true
working-directory: website

- name: Build website
working-directory: website
env:
JEKYLL_PAT: ${{ secrets.JEKYLL_PAT }}
JEKYLL_ENV: production
run: bundle exec jekyll build

- name: Build doxygen - develop
working-directory: develop
run: doxygen

- name: Build doxygen - master
working-directory: master
run: doxygen

- name: Assemble website
run: |
mv website/_site public
mv develop/docs/source-code-documentation/html public/doxygen/develop
mv master/docs/source-code-documentation/html public/doxygen/master

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./public
1 change: 1 addition & 0 deletions .ruby-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.0
95 changes: 51 additions & 44 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,55 +1,55 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (6.0.3.4)
activesupport (7.0.3)
concurrent-ruby (~> 1.0, >= 1.0.2)
i18n (>= 0.7, < 2)
minitest (~> 5.1)
tzinfo (~> 1.1)
zeitwerk (~> 2.2, >= 2.2.2)
addressable (2.7.0)
i18n (>= 1.6, < 2)
minitest (>= 5.1)
tzinfo (~> 2.0)
addressable (2.8.0)
public_suffix (>= 2.0.2, < 5.0)
algolia_html_extractor (2.6.2)
algolia_html_extractor (2.6.4)
json (~> 2.0)
nokogiri (~> 1.10.4)
nokogiri (~> 1.10)
algoliasearch (1.27.5)
httpclient (~> 2.8, >= 2.8.3)
json (>= 1.5.1)
colorator (1.1.0)
concurrent-ruby (1.1.7)
em-websocket (0.5.2)
concurrent-ruby (1.1.10)
date (3.2.2)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
http_parser.rb (~> 0)
eventmachine (1.2.7)
eventmachine (1.2.7-x64-mingw32)
ffi (1.13.1)
ffi (1.13.1-x64-mingw32)
ffi (1.15.5)
ffi (1.15.5-x64-mingw32)
filesize (0.2.0)
forwardable-extended (2.6.0)
gemoji (3.0.1)
html-pipeline (2.14.0)
html-pipeline (2.14.1)
activesupport (>= 2)
nokogiri (>= 1.4)
http_parser.rb (0.6.0)
http_parser.rb (0.8.0)
httpclient (2.8.3)
i18n (1.8.5)
i18n (1.10.0)
concurrent-ruby (~> 1.0)
jekyll (4.1.1)
jekyll (4.2.2)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (~> 2.0)
jekyll-watch (~> 2.0)
kramdown (~> 2.1)
kramdown (~> 2.3)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (~> 0.4.0)
pathutil (~> 0.9)
rouge (~> 3.0)
safe_yaml (~> 1.0)
terminal-table (~> 1.8)
jekyll-algolia (1.6.0)
terminal-table (~> 2.0)
jekyll-algolia (1.7.1)
algolia_html_extractor (~> 2.6)
algoliasearch (~> 1.26)
filesize (~> 0.1)
Expand All @@ -62,9 +62,9 @@ GEM
jekyll (>= 3.3, < 5.0)
jekyll-relative-links (0.6.1)
jekyll (>= 3.3, < 5.0)
jekyll-sass-converter (2.1.0)
jekyll-sass-converter (2.2.0)
sassc (> 2.0.1, < 3.0)
jekyll-seo-tag (2.7.1)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-sitemap (1.4.0)
jekyll (>= 3.7, < 5.0)
Expand All @@ -74,46 +74,53 @@ GEM
gemoji (~> 3.0)
html-pipeline (~> 2.2)
jekyll (>= 3.0, < 5.0)
json (2.3.1)
kramdown (2.3.0)
json (2.6.2)
kramdown (2.4.0)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
listen (3.3.3)
listen (3.7.1)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
mini_portile2 (2.4.0)
minitest (5.14.2)
nokogiri (1.10.10)
mini_portile2 (~> 2.4.0)
nokogiri (1.10.10-x64-mingw32)
mini_portile2 (~> 2.4.0)
open-uri (0.1.0)
mini_portile2 (2.8.0)
minitest (5.15.0)
nokogiri (1.13.6)
mini_portile2 (~> 2.8.0)
racc (~> 1.4)
nokogiri (1.13.6-x64-mingw32)
racc (~> 1.4)
open-uri (0.2.0)
stringio
time
uri
pathutil (0.16.2)
forwardable-extended (~> 2.6)
progressbar (1.10.1)
public_suffix (4.0.6)
rb-fsevent (0.10.4)
progressbar (1.11.0)
public_suffix (4.0.7)
racc (1.6.0)
rb-fsevent (0.11.1)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.4)
rouge (3.25.0)
rexml (3.2.5)
rouge (3.29.0)
safe_yaml (1.0.5)
sassc (2.4.0)
ffi (~> 1.9)
sassc (2.4.0-x64-mingw32)
ffi (~> 1.9)
terminal-table (1.8.0)
stringio (3.0.2)
terminal-table (2.0.0)
unicode-display_width (~> 1.1, >= 1.1.1)
thread_safe (0.3.6)
tzinfo (1.2.8)
thread_safe (~> 0.1)
unicode-display_width (1.7.0)
time (0.2.0)
date
tzinfo (2.0.4)
concurrent-ruby (~> 1.0)
unicode-display_width (1.8.0)
uri (0.11.0)
verbal_expressions (0.1.5)
webrick (1.7.0)
zeitwerk (2.4.2)

PLATFORMS
ruby
Expand All @@ -133,4 +140,4 @@ DEPENDENCIES
webrick

BUNDLED WITH
2.1.4
2.3.10
4 changes: 4 additions & 0 deletions _data/sidebars/docs_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,10 @@ entries:
url: /dev-docs-overview.html
output: web, pdf

- title: Source documentation
url: /dev-docs-sourcedocs.html
output: web

- title: General coding conventions
url: /dev-docs-dev-conventions.html
output: web, pdf
Expand Down
29 changes: 29 additions & 0 deletions pages/docs/dev-docs/dev-sourcedocs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Source Documentation
keywords: pages, development, doxygen, source
permalink: dev-docs-sourcedocs.html
redirect_from: /doxygen/
---

## What do I find here?

This is the source code documentation of the preCICE core library.
It includes the source code documentation including the API documentation of both the latest release and the latest development version.

## preCICE Doxygen

### Latest release

Generated from the current `master` branch of preCICE.
Use this version if you are developping your own adapter for preCICE.

<a class="btn btn-primary" href="/doxygen/master/classprecice_1_1SolverInterface.html" role="button">API</a>
<a class="btn btn-primary" href="/doxygen/master/" role="button">Docs</a>

### Development Version

Generated from the current `develop` branch of preCICE.
Use this version if you plan to contribute to preCICE.

<a class="btn btn-primary" href="/doxygen/develop/classprecice_1_1SolverInterface.html" role="button">API</a>
<a class="btn btn-primary" href="/doxygen/develop/" role="button">Docs</a>