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

Skip to content

Commit 80adda9

Browse files
authored
Merge pull request #1863 from filmor/docs
Documentation
2 parents 15a8b26 + cc2fdac commit 80adda9

16 files changed

+3700
-6
lines changed

.github/workflows/docs.yml

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Documentation
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v1
10+
- name: Doxygen Action
11+
uses: mattnotmitt/[email protected]
12+
with:
13+
working-directory: "doc/"
14+
15+
- name: Build Sphinx documentation
16+
run: |
17+
pip install -r doc/requirements.txt
18+
sphinx-build doc/source/ ./doc/build/html/
19+
20+
- name: Upload artifact
21+
# Automatically uploads an artifact from the './_site' directory by default
22+
uses: actions/upload-pages-artifact@v1
23+
with:
24+
path: doc/build/html/
25+
26+
deploy:
27+
if: github.ref == 'refs/heads/release'
28+
runs-on: ubuntu-latest
29+
permissions:
30+
contents: read
31+
pages: write
32+
id-token: write
33+
environment:
34+
name: github-pages
35+
url: ${{ steps.deployment.outputs.page_url }}
36+
needs: build
37+
steps:
38+
- name: Deploy to GitHub Pages
39+
id: deployment
40+
uses: actions/deploy-pages@v1

Directory.Build.props

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<AssemblyProduct>Python.NET</AssemblyProduct>
77
<LangVersion>10.0</LangVersion>
88
<IsPackable>false</IsPackable>
9-
<FullVersion>$([System.IO.File]::ReadAllText("version.txt").Trim())</FullVersion>
9+
<FullVersion>$([System.IO.File]::ReadAllText("$(MSBuildThisFileDirectory)version.txt").Trim())</FullVersion>
1010
<VersionPrefix>$(FullVersion.Split('-', 2)[0])</VersionPrefix>
1111
<VersionSuffix Condition="$(FullVersion.Contains('-'))">$(FullVersion.Split('-', 2)[1])</VersionSuffix>
1212
</PropertyGroup>

doc/.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
doxygen_xml/
2+
build/

0 commit comments

Comments
 (0)