Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation format #210

Open
papoteur-mga opened this issue Mar 14, 2022 · 4 comments
Open

Documentation format #210

papoteur-mga opened this issue Mar 14, 2022 · 4 comments

Comments

@papoteur-mga
Copy link

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
Copy link
Author

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

@eggplants
Copy link
Contributor

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
Copy link
Contributor

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

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

@eggplants
Copy link
Contributor

eggplants commented Mar 14, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants