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

Build a documentation #6

Open
MarcBresson opened this issue Jun 26, 2024 · 0 comments
Open

Build a documentation #6

MarcBresson opened this issue Jun 26, 2024 · 0 comments
Assignees
@NacerKROUDIR
Labels
documentation Improvements or additions to documentation
Milestone
Amazing documenta...

Comments

@MarcBresson
Copy link
Member

MarcBresson commented Jun 26, 2024 •
edited
Loading

we can build a website using a documentation framework.

The ones I know are:

  • mkdocs (used by PapAI, and Pydantic): great tutorial here
  • Sphinx (used by python)
  • Pdoc

the site can be served on GitHub pages while waiting for our team to serve it on our servers
@MarcBresson MarcBresson added this to the Amazing documentation milestone Jun 26, 2024
@MarcBresson MarcBresson added the documentation Improvements or additions to documentation label Jun 26, 2024
@NacerKROUDIR NacerKROUDIR moved this from Todo to In Progress in Fair-Mango roadmap Aug 6, 2024
@NacerKROUDIR NacerKROUDIR self-assigned this Aug 6, 2024
@NacerKROUDIR NacerKROUDIR linked a pull request Aug 6, 2024 that will close this issue
Doc/add docstrings #17
Merged
@NacerKROUDIR NacerKROUDIR removed a link to a pull request Aug 6, 2024
Doc/add docstrings #17
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@NacerKROUDIR NacerKROUDIR

Labels
documentation Improvements or additions to documentation
Projects
Fair-Mango roadmap
Status: In Progress
Milestone
Amazing documentation
Development

No branches or pull requests
2 participants
@MarcBresson @NacerKROUDIR