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.

Sign up for GitHub

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

Jump to bottom

[WIP] Add the documentation #1

Open
wants to merge 2 commits into
base: develop/0.1.0
Choose a base branch
from
Open

[WIP] Add the documentation #1

wants to merge 2 commits into from

Conversation

scizorman
Copy link
Owner

Overview

For users, let's write the documentation of this package.

To Do

  • Add sphinx
  • Write docs
    • What is VDIF?
    • Installation
    • Examples
    • References
  • Publish to GitHub Pages using CI
    • Add the job to build and publish docs

Note

Use sphinx-rtd-theme.

@scizorman scizorman added documentation Improvements or additions to documentation WIP Work In Progress labels Jul 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation WIP Work In Progress
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@scizorman