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.

Sign up for GitHub

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

Jump to bottom

[doc] Add documentation generation with sphynx #3

Closed
4 tasks
jmkerloch opened this issue Jan 10, 2023 · 0 comments · Fixed by #11
Closed
4 tasks

[doc] Add documentation generation with sphynx #3

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

Comments

@jmkerloch
Copy link
Contributor

Add documentation with sphynx:

  • create a root directory documentation
  • add conf.py to define sphynx option
  • TO BE DISCUSSED : 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 jmkerloch mentioned this issue Jan 10, 2023
Closed
3 tasks
@gwenandres gwenandres self-assigned this Jan 17, 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
@gwenandres gwenandres mentioned this issue Jan 20, 2023
Merged
@gwenandres gwenandres linked a pull request Jan 23, 2023 that will close this issue
feat(doc) move documentation and init sphynx build #11
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gwenandres gwenandres

Labels
documentation Improvements or additions to documentation sprint1 Issue or pull request related to sprint1
Projects
Road2 backlog
Status: ✅ Done
Milestone
sprint1
Development

Successfully merging a pull request may close this issue.

feat(doc) move documentation and init sphynx build IGNF/pgrouting-procedures
2 participants
@gwenandres @jmkerloch