Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Get docs working via Travis & github pages #8

Merged
merged 1 commit into from
Mar 21, 2019

Conversation

rohanpm
Copy link
Member

@rohanpm rohanpm commented Mar 21, 2019

Basic skeleton of docs are in place.

Currently, the classes/methods appearing in "API reference" should
be considered as examples only. I'm not sure exactly what should
go in there as it still seems a bit unclear what is and isn't
public API. The main goal here is to get the doc building toolchain
up and running.

@rohanpm rohanpm requested a review from a team March 21, 2019 00:33
@rohanpm
Copy link
Member Author

rohanpm commented Mar 21, 2019

A GITHUB_TOKEN will need to be added to Travis CI env vars before the push from master can work.

@rohanpm
Copy link
Member Author

rohanpm commented Mar 21, 2019

Per discussion in #9, it might make sense to drop all the references to API for now.

docs/conf.py Outdated
# -- Project information -----------------------------------------------------

project = 'ubi-population-tool'
copyright = '2018, Red Hat'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2019 right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, fixed.

Basic skeleton of docs are in place.

Currently, the classes/methods appearing in "API reference" should
be considered as examples only.  I'm not sure exactly what should
go in there as it still seems a bit unclear what is and isn't
public API.  The main goal here is to get the doc building toolchain
up and running.
@rbikar
Copy link
Member

rbikar commented Mar 21, 2019

Token added to travis, merging.

@rbikar rbikar merged commit 6d359fc into release-engineering:master Mar 21, 2019
@rohanpm rohanpm deleted the build-docs branch March 21, 2019 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants