Refty / mongo-thingy

:leaves: Powerful schema-less ODM for MongoDB and Python (sync + async)

https://mongo-thingy.readthedocs.io

MIT License

68 stars 12 forks source link

Feature/mkdocs #53

Open abhishekpcnair opened 7 months ago

abhishekpcnair commented 7 months ago

49 Ported from sphinx to mkdocs material theme

ramnes commented 7 months ago

Hey, thanks for your work! Is the result visible somewhere?

One important thing: we shouldn't have the mkdocs output (minified files and such) in the repository. Instead we should use a GitHub action and push that output in a branch.

You can have a look here at how we've done it for notion-sdk-py, specifically the .github/workflows/docs.yml file: https://github.com/ramnes/notion-sdk-py/pull/30

abhishekpcnair commented 7 months ago

Noted I will fix them, but the docs with sphinx right now is hosted in readthedocs right? If so, then something like this should work https://about.readthedocs.com/tools/mkdocs/

abhishekpcnair commented 7 months ago

Not very familiar with the GH, but after some trial and error, here it is https://abhishekpcnair.github.io/mongo-thingy/

The order of sections need some work though, but this could be a good starting point

coveralls commented 7 months ago

coverage: 100.0%. remained the same when pulling 176c97b4ea2d6634747b08ee4357b7bdc352563d on abhishekpcnair:feature/mkdocs into 879fd7cf7437c63d7bc1e7e37e4dcf0cdf7ac882 on Refty:master.