Skip to content
This repository has been archived by the owner on May 9, 2024. It is now read-only.

Setup sphinx #9

Closed
pdiazvargas opened this issue Feb 13, 2019 · 0 comments
Closed

Setup sphinx #9

pdiazvargas opened this issue Feb 13, 2019 · 0 comments
Labels
enhancement New feature or request

Comments

@pdiazvargas
Copy link
Contributor

What

  • Configure sphinx as the framework of choice for documentation purposes.
  • As part of the configuration process, refactor the documentation in the README in a more logical manner.
  • Update README to include a section on how to build / update the docs
  • Setup the gh-pages branch to host the documentation.

How

Install sphinx and run the initial configuration. Once the initial config is done, streamline and simplify the README file of the project by moving the auxiliary info to it's own page in the sphinx docs.
@pdiazvargas pdiazvargas added the enhancement New feature or request label Feb 24, 2019
@pdiazvargas pdiazvargas mentioned this issue Feb 25, 2019
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pdiazvargas