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

Add automatic documentation via GitHub Pages #771

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

srounce
Copy link
Contributor

@srounce srounce commented Dec 25, 2018

🎅🎄🎁☃️👼❄️🌟

Pretty self-explanatory really.

What it does

  1. Commits go into master
  2. Doxygen gets run in Travis CI environment and generates cpp_utils documentation
  3. HTML gets published to https://nkolban.github.io/esp32-snippets.

Todo:

Before merging the following will have to be done by someone with the required access level to this repository:

@srounce
Copy link
Contributor Author

srounce commented Jan 25, 2019

@nkolban @chegewara

Any chance of getting some feedback on this?

@chegewara
Copy link
Collaborator

Hi @srounce
As you mentioned there is few thing TODO before merging this. I have no idea how much time it require to setup it but we both are busy now, but when i find some time i will try to prepare it.
It is good idea to have it done, but it also require to review whole code and add necessary documentation comments where they are missing.

@maxbachmann
Copy link

@chegewara I do not really see the problem.
The ToDo is

  • Setup Travis which is actually create a account and activate it for the repository
  • create a token in the github developer settings and add it to travis as a secret variable called GITHUB_TOKEN
  • activate github pages for the repository
  • sure more comments for everything would be nice, but thats the case wether it´s on github pages or not. And when the documentation get´s improved over time the documentation on github pages will aswell, so thats not really a problem

@chegewara
Copy link
Collaborator

  • create a token in the github developer settings and add it to travis as a secret variable called GITHUB_TOKEN

Thats the point, i dont have access to repository settings.

@maxbachmann
Copy link

Yeah thats a valid point ;) (only @nkolban has access?)

@srounce
Copy link
Contributor Author

srounce commented May 7, 2019

@maxbachmann It could probably do with a bit of prettying up. My fork currently has it set up and is visible here: https://srounce.github.io/esp32-snippets
If you would like to help make them look nice and engaging for users/readers then you're more than welcome to add some commits to my branch.

@maxbachmann
Copy link

I will definetly look into it

@madsdyd
Copy link

madsdyd commented Jun 7, 2020

@chegewara Maybe we could petition @nkolban to give you access to change the repository settings? It would be really great to have docs automatically created.

@srounce
Copy link
Contributor Author

srounce commented Oct 5, 2020

I'd love to get this branch merged if possible.

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.

4 participants