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

Setup git and sphinx on server #20

Closed
jgostick opened this issue Sep 22, 2013 · 3 comments
Closed

Setup git and sphinx on server #20

jgostick opened this issue Sep 22, 2013 · 3 comments
Assignees
Milestone

Comments

@jgostick
Copy link
Member

Andreas, can you log into the openpnm server and set it up so that:

It reads the latest git repo every x minutes
Runs Sphinx every x minutes
Put a link in the var/www/openpnm folder to the Sphinx /_build folder?

This way the docs are up to date and on the site. I guess this will always be the dev docs. We will want make static folders for specific versions as we go to paste in the html files.

Also, i have been having trouble building the docs on my machine, so we could make sure the server is setup right and then just use that as our default doc generator.

@ghost ghost assigned putza Sep 22, 2013
@putza
Copy link
Contributor

putza commented Sep 25, 2013

I suggest the automatic build for the latest release, not necessarily the trunk as the trunk can be broken.

Maybe a link with caution to the development build.

I will tr to implement this until next meeting.

@putza
Copy link
Contributor

putza commented Oct 2, 2013

TODO:

  • create git post commit hub to run make html for
    • release branch
    • develop
  • Create link to documentation

This was referenced Oct 3, 2013
@jgostick
Copy link
Member Author

We have a first attempt at the docs online. The server can now pull the Git repo, generate the html, and the Wordpress sites links there. This will need fine tuning for sure, but it good enough for the foreseeable future.

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

No branches or pull requests

2 participants