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

FEATURE: Create a webpage for the project #19

Closed
mpu-creare opened this issue May 7, 2018 · 4 comments
Closed

FEATURE: Create a webpage for the project #19

mpu-creare opened this issue May 7, 2018 · 4 comments
Assignees
Labels

Comments

@mpu-creare
Copy link
Contributor

Should have auto-generated reference docs from docstrings as well as more user-friendly documentation for users, developers, and advocates

@mpu-creare mpu-creare added the doc label May 7, 2018
@mpu-creare mpu-creare added this to To do in PODPAC Development via automation May 7, 2018
@mlshapiro
Copy link
Contributor

docs are being served: https://creare-com.github.io/podpac-docs/

need to auto generate using gist here: https://gist.github.com/domenic/ec8b0fc8ab45f39403dd

@mlshapiro
Copy link
Contributor

mlshapiro commented May 11, 2018

todo:

  • automate build on commit using travis
  • implement and demo numpy autodoc
  • tighten up current documentation copy
  • add branding
  • fix image in design
  • implement doctests
  • implement doc versions

@mlshapiro
Copy link
Contributor

@mlshapiro mlshapiro self-assigned this May 15, 2018
@mlshapiro
Copy link
Contributor

we have not implemented a versioning system for the docs yet, but that doesn't yet feel necessary, we can put an issue on the board for later to address maintaining document versions.

Otherwise this is implemented at first pass.

PODPAC Development automation moved this from To do to Done May 15, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Development

No branches or pull requests

2 participants