search

deel-ai / deel-lip

Build and train Lipschitz constrained networks: TensorFlow implementation of k-Lipschitz layers
https://deel-ai.github.io/deel-lip/
MIT License
89 stars 10 forks source link

docs: migrate docs from sphynx to mkdocs #67

Closed lucashervier closed 1 year ago

lucashervier commented 1 year ago

This PR should enable the documentation to be migrated from Sphynx to MkDocs. Mainly, this would allow some visual unity between all @deel-ai/core libraries. Along the way I propose a new logo and new banners (that can obviously be discussed and changed). Do not hesitate to tell me in the discussion if you want to modify the README.md or the docs/index.md file to add some content.

Minor changes were brought to adapt from sphynx to mkdocs in the scripts docstrings (mainly :math:, :func: were changed to `` and $$.)

I might have missed some links change so be careful ;)

Holt59 commented 1 year ago

mkdocstrings-python should be added to the list of dependencies for documentation generation.