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

Use MkDocs for the documentation #331

Merged
merged 11 commits into from
Nov 12, 2023
Merged

Use MkDocs for the documentation #331

merged 11 commits into from
Nov 12, 2023

Conversation

rlouf
Copy link
Member

@rlouf rlouf commented Nov 1, 2023

This PR switched the documentation from Sphinx to Mkdocs, which comes with better visual defaults and plugins. Markdown has a broader appeal than restructured text for potential contributors.

Landing page:

2023-11-01-183727_1501x784_scrot

TODO

  • Add API documentation.
  • Update the documentation with the current interface
  • Add documentation for regex-guided generation
  • Add documentation for JSON-guided generation
  • Add at least one example

@rlouf rlouf force-pushed the docs-mkdocs branch 3 times, most recently from 48b3cae to 1c5f01b Compare November 1, 2023 17:49
@rlouf rlouf marked this pull request as draft November 1, 2023 17:52
@rlouf rlouf added the documentation Linked to documentation and examples label Nov 1, 2023
@rlouf rlouf force-pushed the docs-mkdocs branch 11 times, most recently from bf8e6df to 923fba3 Compare November 2, 2023 07:28
@rlouf rlouf marked this pull request as ready for review November 10, 2023 15:41
@rlouf
Copy link
Member Author

rlouf commented Nov 10, 2023

This is already a big change, will open issues to add documentation and examples.

@rlouf rlouf merged commit 0fe5d05 into outlines-dev:main Nov 12, 2023
5 checks passed
@rlouf rlouf deleted the docs-mkdocs branch January 11, 2024 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Linked to documentation and examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant