Skip to content

Commit 0efbe29

Browse files
committed
Automate documentation generation and move generated content to the gh-pages branch
1 parent 902cd96 commit 0efbe29

File tree

131 files changed

+987
-48699
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

131 files changed

+987
-48699
lines changed

.appveyor.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ branches:
99
- /^feature\/.*/
1010
build_script:
1111
- ps: .\build.ps1 -IsOfficialBuild
12+
- ps: .\docs\generate.ps1
1213
environment:
1314
global:
1415
DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,4 @@ node_modules/
3535
.vscode/
3636
.idea/
3737
*.iml
38-
global.json
39-
korebuild-lock.txt
38+
.build/

CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,7 @@ A few simple rules for the road.
99

1010
## Contributing to the documentation
1111

12-
If you are contributing to the documentation, ensure that your Pull Request does not contain updates to any files in the `/docs` folder and only updates to files in the `/docfx_project` folder. The `/docs` folder is where **DocFX** generates the documentation, and due to the verbose nature of those files, it makes reviewing Pull Requests a difficult process. Also, the files generated in that folder will contain links to your forked repo which is not correct.
12+
If you are contributing to the documentation, you can build and preview the docs by executing `./docs/generate.ps1`. The `/docs` folder contains the source which **DocFX** uses generates the documentation.
13+
The results of this are saved to the `gh-pages` branch of the repository.
14+
15+
Run `./docs/generate.ps1 -Serve` to build the docs and serve them on <http://localhost:8080>.

docs/.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* binary

docs/api/McMaster.Extensions.CommandLineUtils.Abstractions.CommandLineContext.html

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

0 commit comments

Comments
 (0)