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

Use Sphinx to build documentation #22

Open
4 tasks
jrenaud90 opened this issue Sep 28, 2020 · 0 comments
Open
4 tasks

Use Sphinx to build documentation #22

jrenaud90 opened this issue Sep 28, 2020 · 0 comments
Labels
Beginner Issue is good for newcomers to TidalPy Cosmetic / QOL Features that make the code easier to use but do not change performance or functionality Docs Documentation and/or Doc Strings needed
Milestone

Comments

@jrenaud90
Copy link
Owner

The beginnings of this were implemented in version 0.2.1, but the sphinx documentation is sparse compared to the older markdown files.

  • Rewrite old markdown files into new rst files that are used by sphinx (Documentation/source/index.rst).
  • Look into how to host the html documentation files on github.

Commit Workflow

  • Run sphinx-apidoc to make rst files for all TidalPy modules
  • Run make html (make.bat html for windows) to build the html files (these make files should be in the Documentation directory)
@jrenaud90 jrenaud90 added Beginner Issue is good for newcomers to TidalPy Docs Documentation and/or Doc Strings needed Cosmetic / QOL Features that make the code easier to use but do not change performance or functionality labels Sep 28, 2020
@jrenaud90 jrenaud90 added this to the Version 0.3.0 milestone Sep 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Beginner Issue is good for newcomers to TidalPy Cosmetic / QOL Features that make the code easier to use but do not change performance or functionality Docs Documentation and/or Doc Strings needed
Projects
None yet
Development

No branches or pull requests

1 participant