Search code examples
pythondjangodjango-rest-framework

django rest framework offline documentation


I need to get the documentation for django rest framework for offline usage, Why? b/c I live in Ethiopia and the internet is too damn slow for me to go online just to the doc of APIView. So does anybody know of a link where I can find the offline version of the documentation? The pdf on readthedoc is outdated and empty and I can't seem to find any other alternative.


Solution

  • The documentation for DRF is contained within the main repo. You can use mkdocs serve to serve the documentation locally.

    Checkout the DRF repo:

    git clone https://github.com/encode/django-rest-framework.git
    cd django-rest-framework
    

    Install and run mkdocs. You must do this in the above directory which contains mkdocs.yml.

    pip install mkdocs
    mkdocs serve
    

    Visit http://127.0.0.1:8000 in your web browser.