Documentation theme requires more work

[purva-thakre]

Related to #467, #440 and #416

• The default logo in the header of the theme is hidden due to below.

toqito/docs/_static/custom.css

Lines 1 to 4 in c44a3c7

	/* Hide default logo in header */
	a.logo.navbar-brand {
	display: none;
	}

In the default version of the theme, the logo and theme name appears. We want to replace the sphinx-wagtail logo with the logo for toqito and replace Sphinx Wagtail Theme with something like Toqito Documentation which could act as the home page for the documentation.

• The default options in the footer are hidden due to below.
  

  toqito/docs/_static/custom.css

  Lines 6 to 9 in c44a3c7

  	/* Hide default options in footer */
  	ul.nav.justify-content-center.mb-2 {
  	display: none;
  	}

  
  We want to replace the default theme options in the footer with About Toqito, Info about the documentation build/theme etc..
  

• On the home page of the documentation, all functions in the API reference are listed. It might be better to list only the modules and not the functions on this page. Probably related to changing the maxdepth

  toqito/docs/autoapi_members.rst

  Lines 4 to 5 in c44a3c7

  	.. toctree::
  	:maxdepth: 2

• The Edit on Github button is broken for functions in API Reference after the API structure was changed in Switch to AutoAPI #440. We want to redirect all such broken links to the main repo or to the appropriate modules. For example, if the Edit on Github link to docs/autoapi/channel_metrics/channel_fidelity is broken:
  - Option 1: we want to re-direct it to toqito/channel_metrics instead. Same for other modules.
  - Option 2: we want to re-direct all broken links to toqito/toqito. Only 1 link to maintain compared to Option 1.

[purva-thakre]

For the last item, found a resource that could be helpful. In this case, we simply remove the Edit on Github option for the automatically generated pages.

https://docs.readthedocs.io/en/stable/guides/remove-edit-buttons.html