drf-yasg VS pages-gem

I believe drf-yasg what you need. You can create a schema manually and define request and response types for your small API.

Check this out: https://drf-yasg.readthedocs.io/en/stable/

There's also the caveat of having different API documentation for both the frontend solution and the API-only solution, since I don't want to expose the frontend-specific endpoints to the API-only endpoints, but I think that might just take some time playing around with swagger: https://drf-yasg.readthedocs.io/en/stable/

Swagger and OpenAPI capabilities using drf-yasg, where you can only see endpoints and Swagger docs if you have a valid Token

The major apps are news and accounts. While the former handles almost all the physical functionalities of the system, the latter only does user stuff. The api app exposes the data for consumption. It is documented using drf-yasg, a Swagger generation tool implemented without using the schema generation provided by Django Rest Framework. The api has a token-based authentication which requires that all POST requests must provide a token to be accepted, otherwise a not too interesting response:

Our RESTful API was actually the easiest to document, because we were able to rely on third-party libraries from the start. It was a Python Django and Django REST Framework project that leveraged the drf-yasg OpenAPI generator library to create OpenAPI and Swagger compatible documentation.

This post will go through how to document your DRF APIs using https://github.com/axnsan12/drf-yasg/ package.

It's super easy to publish a static site like the resume with GitHub Pages. Just check out the docs.

GitHub Pages: Host your static websites directly from your GitHub repository.

As per many other comments, it sounds like a static site generator like Hugo (https://gohugo.io/) or Jekyll (https://jekyllrb.com/), hosted on GitHub Pages (https://pages.github.com/) or GitLab Pages (https://about.gitlab.com/stages-devops-lifecycle/pages/), would be a good match. If you set up GitHub Actions or GitLab CI/CD to do the build and deploy (see e.g. https://gohugo.io/hosting-and-deployment/hosting-on-github/), your normal workflow will simply be to edit markdown and do a git push to make your changes live. There are a number of pre-built themes (e.g. https://themes.gohugo.io/) you can use, and these are realtively straightforward to tweak to your requirements.

Ideal for open source projects, docs sites, and portfolios. GitHub Pages

Github Pages: Link to Github Pages

Once you have all the documentation worked out a place to host it will be necessary. Some documentation generation may have ties in with specific hosting sites. Read The Docs' support for Sphinx and other documentation tools is one example. GitHub pages can be useful for GitHub hosted projects as it integrates well with GitHub Actions CI/CD deployments.

If you use GitHub and need to host a static website, consider GitHub Pages. Free for one site Stored on a GitHub public respository Deploy via web interface, or Git 100GB/month free bandwidth

https://pages.github.com/ https://docs.github.com/en/pages https://docs.github.com/en/pages/quickstart https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll

There are plenty of other hosting options you could use instead, such as GitHub Pages.

Functionally github.io just presents whatever you throw into the repository as the root directory of a site, github themselves host a very good, basic outline of how to set up a site on github.io.