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

Set up infrastructure for code documentation #7

Open
1 of 10 tasks
nicklafarge opened this issue Nov 9, 2022 · 3 comments · May be fixed by #17
Open
1 of 10 tasks

Set up infrastructure for code documentation #7

nicklafarge opened this issue Nov 9, 2022 · 3 comments · May be fixed by #17
Assignees
Labels
Domain: Documentation Issues related to documentation good first issue Good for newcomers

Comments

@nicklafarge
Copy link
Member

nicklafarge commented Nov 9, 2022

We need documentation that includes both a user guide and C++/Python code documentation. We need to decide

  • Decide where this will be hosted? (Github Pages? readthedocs?)
  • Set up web hook for documentation building
  • Documentation for C++ (Sphinx?)
  • Documentation for Python via pybind11 (Sphinx is supported)
  • Documentation for Matlab functionality (???)
  • Basic Organization
    • Getting started
    • Building from source
    • C++ Docs
    • Python Docs
@nicklafarge nicklafarge added Domain: Documentation Issues related to documentation good first issue Good for newcomers labels Nov 9, 2022
@rjpower4 rjpower4 linked a pull request Nov 9, 2022 that will close this issue
15 tasks
@nicklafarge nicklafarge self-assigned this Nov 15, 2022
@nicklafarge
Copy link
Member Author

@rjpower4 What are your thoughts on hosting? I think readthedocs would be a good options - free for open source projects, integrates with CI, looks like it supports Sphinx, and is really simple to use. GitHub pages is of course another option, but then we have to decide on a template and there might be a bit more DIY-ness to it. What do you think?

@rjpower4
Copy link
Member

Readthedocs works for me, though I have never used it before. I don't really have a preference here.

@nicklafarge
Copy link
Member Author

Alright let's go with readthedocs for now then. I think I will need you to set up the webhook for it (I tried but I don't think I have permission to do that)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Domain: Documentation Issues related to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants