AppVeyor, Sandcastle, and Pull Requests

Mike-EEE's Avatar

Mike-EEE

15 Nov, 2019 03:40 PM

We are looking into our documentation processes, which rely on Sandcastle. Currently Sandcastle is not part of the AppVeyor build, but according to this issue:

https://github.com/EWSoftware/SHFB/issues/606#issuecomment-550027689

It would seem that it can be.

That is only part of our problem, which doesn't seem to be many answers after searching around.

If we add Sandcastle to the build process, it spits out HTML as a website, which is valuable. What we'd like to do is take the versioned outputs of this Sandcastle project, and then create a PR back into the repository that kicked off the build with the new documentation.

The documentation would get built to the /docs/ directory, which is configured for GitHub pages.

BTW this is obviously only to occur on tag-based releases when we also send out our Nuget deployments.

This seems like a good approach, but it seems like no one else is doing this, and there are no resources discussing it.

So, curious if this can be done, and if there might be a more obvious way to handle documentation process with AppVeyor.

  1. 1 Posted by Mike-EEE on 15 Nov, 2019 08:41 PM

    Mike-EEE's Avatar

    Looks like DocFX is the answer here:

    https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#41-steps

    Following the docfx-seed link takes you to a very valuable appveyor.yml document that looks like it does everything that I was describing:
    https://github.com/docascode/docfx-seed/blob/master/appveyor.yml

    So, if docfx doesn't pan out, it at least looks like we can apply the magic in this .yml file to Sandcastle outputs.

  2. Support Staff 2 Posted by Feodor Fitsner on 16 Nov, 2019 04:05 AM

    Feodor Fitsner's Avatar

    Glad you solved it, thanks for sharing the solution!

  3. Mike-EEE closed this discussion on 19 Nov, 2019 11:10 AM.

Comments are currently closed for this discussion. You can start a new one.

Keyboard shortcuts

Generic

? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac

Recent Discussions

05 Dec, 2019 09:12 PM
04 Dec, 2019 07:46 PM
04 Dec, 2019 12:01 AM
04 Dec, 2019 12:00 AM
03 Dec, 2019 11:00 PM