GIthub pages and docs

As you mentioned, the online documentation for the various OpenDXL solutions are hosted using Github Pages. To set them up, we used the following guide:

• Getting Started with GitHub Pages

(For whatever reason, GitHub typically tries to direct users to a more general "What is GitHub Pages?" article, which is much less helpful.)

Actually, that is not the process I use.

Basically, what I do is the following (there are multiple ways, but I will describe this via the GitHub UI).

1.) Navigate to your repository on GitHub

2.) Click the "branch" pulldown (master by default)

3.) Type in "gh-pages" and click "create branch: gh-pages"

4.) Clone the "gh-pages" branch and delete the existing content. Add the content you want to host (pydocs, etc.).

5.) Click on "settings" in your repository on GitHub

6.) Scroll to the "GitHub Pages" section. Ensure "source" is set to "gh-pages branch"

Again, there are many ways to do this, but this is essentially what I do.

Thanks,

Chris

Bootstrap will generate the initial documentation. You will want to update it with information that is specific to the solution you are developing.

This following portion of the bootstrap tutorial walks through creating a distribution, which includes building the documentation via Sphinx (generating HTML from the documentation source files).

Tutorial Part 5: Package Distributions

Thanks,

Chris