search

RDFLib / sparqlwrapper

A wrapper for a remote SPARQL endpoint
https://sparqlwrapper.readthedocs.io/
Other
526 stars 122 forks source link

Documentation format #210

Open papoteur-mga opened 2 years ago

papoteur-mga commented 2 years ago

https://sparqlwrapper.readthedocs.io/en/2.0.0/genindex.html has a bad layout. Texts are larger than columns. I think that a layout with one column would be better.

papoteur-mga commented 2 years ago

Furthermore, the link to "Edit in Github" goes to a 404 error.

eggplants commented 2 years ago

Special names

Sphinx reserves some document names for its own use; you should not try to create documents with these names – it will cause problems. The special document names (and pages generated for them) are:

  • genindex, modindex, search

These are used for the general index, the Python module index, and the search page, respectively. The general index is populated with entries from modules, all index-generating object descriptions, and from index directives. The Python module index contains one entry per py:module directive. The search page contains a form that uses the generated JSON search index and JavaScript to full-text search the generated documents for search words; it should work on every major browser that supports modern JavaScript.

https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#special-names

eggplants commented 2 years ago

The style of genindex.html, generated by genindex, is often broken.

i.e.) https://pyswarms.readthedocs.io/en/latest/genindex.html

eggplants commented 2 years ago

And if sphinx thema changes into other one, this issue can be fixed.

i.e.) https://optuna.readthedocs.io/en/stable/genindex.html

https://github.com/optuna/optuna/blob/master/docs/source/conf.py