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

[doc] Add documentation generation with sphinx #14

Closed
3 tasks done
jmkerloch opened this issue Jan 10, 2023 · 2 comments · Fixed by #27
Closed
3 tasks done

[doc] Add documentation generation with sphinx #14

jmkerloch opened this issue Jan 10, 2023 · 2 comments · Fixed by #27
Assignees
Labels
documentation Improvements or additions to documentation sprint1 Issue or pull request related to sprint1
Milestone

Comments

@jmkerloch
Copy link
Contributor

jmkerloch commented Jan 10, 2023

Add documentation with sphinx:

  • add conf.py to define sphinx option
  • move all .md documentation files to the documentation directory
  • create landing page documentation/index.md
@jmkerloch jmkerloch added documentation Improvements or additions to documentation sprint1 Issue or pull request related to sprint1 labels Jan 10, 2023
@jmkerloch jmkerloch added this to the sprint1 milestone Jan 10, 2023
@jmkerloch
Copy link
Contributor Author

@lgrd @azarz I'm moving all documentation to the documentation directory. Without move I can't use the file in the table of content used by Sphinx.

@lgrd
Copy link
Collaborator

lgrd commented Jan 17, 2023

yes, it's ok. But you will have to change some links I think.

@jmkerloch jmkerloch changed the title [doc] Add documentation generation with sphynx [doc] Add documentation generation with sphinx Jan 17, 2023
@jmkerloch jmkerloch self-assigned this Jan 18, 2023
@jmkerloch jmkerloch added sprint1 Issue or pull request related to sprint1 and removed sprint1 Issue or pull request related to sprint1 labels Jan 20, 2023
@jmkerloch jmkerloch linked a pull request Jan 23, 2023 that will close this issue
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 sprint1 Issue or pull request related to sprint1
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants