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

Begin automatic documentation #11

Open
6 tasks
paddy-r opened this issue Jan 21, 2023 · 0 comments
Open
6 tasks

Begin automatic documentation #11

paddy-r opened this issue Jan 21, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@paddy-r
Copy link
Owner

paddy-r commented Jan 21, 2023

Create doc folder once new file structure established (see issue #3). Ultimate goal is to create self-documenting code in parallel with manual and readme.

  • Start with doc folder
  • Add some docstrings to step_parse for starters
  • Choose output format via Sphinx
  • Check deployment (via Github Pages or Read the Docs -> decide!)
  • Add anything to .gitignore to tidy up
  • Draw line when output looks good; then raise another issue to streamline readme, manual and automated (code) documentation into fewer processes/outputs
@paddy-r paddy-r added the documentation Improvements or additions to documentation label Mar 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant