Skip to content
This repository was archived by the owner on Mar 5, 2025. It is now read-only.

[WIP] Add the documentation#1

Open
scizorman wants to merge 2 commits intodevelop/0.1.0from
feature/docs
Open

[WIP] Add the documentation#1
scizorman wants to merge 2 commits intodevelop/0.1.0from
feature/docs

Conversation

@scizorman
Copy link
Owner

@scizorman scizorman commented Jul 19, 2019

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 subscribe to this conversation on GitHub. Already have an account? Sign in.

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