AlexandriaILS / Alexandria

Open Source Integrated Library System
1 stars 2 forks source link

Investigate swapping to mkdocs and serving locally #48

Open itsthejoker opened 2 years ago

itsthejoker commented 2 years ago

As wonderful and gorgeous as retype is, the fact that the docs cannot easily be served from a local install is a serious problem. We want the docs for the specific installed version to be readily available for anyone who needs them, which means that retype is just not as enticing as it was, even if the markdown files are in the repo.

This is old, but looks like it might be able to be brought up to speed: https://github.com/tboulogne/django-mkdocs and adding a /docs/ path to the server would ensure that the docs would also update automatically with the installed server version, so the two would always be in sync.