Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork630
Add docfx documentation#985
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
nitanmarcel wants to merge9 commits intoscripthookvdotnet:mainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Uh oh!
There was an error while loading.Please reload this page.
Open
Changes fromall commits
Commits
Show all changes
9 commits Select commitHold shift + click to select a range
0760495 Add docfx documentation
nitanmarcel15201f5 Fix index.md in doc/scripting_v2 and doc/scripting_v2
nitanmarcel65985a2 Remove unused docfx.json keys
nitanmarcelc630bff Fix footer
nitanmarcelc661f7b Disable Contribution links
nitanmarcelf87e1dd Change app's title
nitanmarcel40d0d91 Use the documentation as a submodule
nitanmarcel1d068a4 Also checkout submodules
nitanmarcel9f2c2bd Update documentation submodule
nitanmarcelFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
85 changes: 85 additions & 0 deletions.github/workflows/doc-gen.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| name: Docfx Documentation Generator | ||
| on: | ||
| push: | ||
| tags: | ||
| - 'v3*' | ||
| jobs: | ||
| preparation: | ||
| name: Pre Documentation Generation | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v2.3.4 | ||
| with: | ||
| ref: main | ||
| submodules: true | ||
| - name: Fetch Changelog For V2 | ||
| id: changelog_two | ||
| uses: heinrichreimer/action-github-changelog-generator@v2.2 | ||
| with: | ||
| token: ${{ github.token }} | ||
| sinceTag: v0.1 | ||
| dueTag: v2.10.10 | ||
| issues: true | ||
| issuesWoLabels: true | ||
| prWoLabels: true | ||
| author: true | ||
| verbose: true | ||
| compareLink: true | ||
| httpCache: true | ||
| - name: Fetch Changelog For V3 | ||
| id: changelog_three | ||
| uses: heinrichreimer/action-github-changelog-generator@v2.2 | ||
| with: | ||
| token: ${{ github.token }} | ||
| sinceTag: v2.10.10 | ||
| issues: true | ||
| issuesWoLabels: true | ||
| prWoLabels: true | ||
| author: true | ||
| verbose: true | ||
| compareLink: true | ||
| httpCache: true | ||
| - name: Generate Changelog | ||
| uses: cschleiden/replace-tokens@v1.0 | ||
| with: | ||
| files: '["scripthookvdotnet-doc/scripting_v2/index.md", "scripthookvdotnet-doc/scripting_v3/index.md"]' | ||
| env: | ||
| CHANGELOGV2: ${{ steps.changelog_two.outputs.changelog }} | ||
| CHANGELOGV3: ${{ steps.changelog_three.outputs.changelog }} | ||
| - name: Upload Artefacts | ||
| uses: actions/upload-artifact@v2 | ||
| with: | ||
| name: gen-doc | ||
| path: . | ||
| pages: | ||
| strategy: | ||
| matrix: | ||
| os: [windows-2019] | ||
| include: | ||
| - os: windows-2019 | ||
| vs: [2019] | ||
| name: Documentation Generation | ||
| needs: preparation | ||
| runs-on: ${{ matrix.os }} | ||
| steps: | ||
| - name: Install Depedencies | ||
| run: choco install docfx | ||
| - name: Clear Working Directory | ||
| run: rm -r * | ||
| - name: Download Artefacts | ||
| uses: actions/download-artifact@v2 | ||
| with: | ||
| name: gen-doc | ||
| path: . | ||
| - name: Documentation Generation | ||
| run: docfx scripthookvdotnet-doc/docfx.json | ||
| - name: Deploy | ||
| uses: peaceiris/actions-gh-pages@v3 | ||
| with: | ||
| publish_dir: scripthookvdotnet-doc/_site | ||
| github_token: ${{ github.token }} | ||
3 changes: 3 additions & 0 deletions.gitmodules
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| [submodule "scripthookvdotnet-doc"] | ||
| path = scripthookvdotnet-doc | ||
| url = https://github.com/nitanmarcel/scripthookvdotnet-doc |
1 change: 1 addition & 0 deletionsscripthookvdotnet-doc
Submodulescripthookvdotnet-doc added at 29f49b
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.