Jak dołączyć toctree na bocznym pasku każdej strony

Question

Generuję dokumentację html w Sphinx.

Jak zmodyfikować pasek boczny dla każdej strony HTML w moim dokumencie, tak aby zawierały one numer identyfikacyjny? Domyślnie atrybut zdalny pojawia się tylko na stronie master_doc i tylko w obszarze głównym zamiast paska bocznego.

Czy istnieje prosty sposób na zrobienie tego? Będę korzystał z readthedocs do przechowywania wygenerowanej dokumentacji, więc wolałbym unikać używania jakichkolwiek wtyczek firm trzecich, chyba że są one również dostępne w readthedocs.

Answer 1

Możesz dostosować swój boczny html w conf.py.

Domyślny html boczny składa się z 4 szablonów:

['localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'] 

W conf.py można zmienić localtoc.html do globaltoc.html tak:

html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'], } 

Ale nie jestem pewien, czy to działa na readthedocs.

Answer 2

Włączenie "globaltoc.html" ma tę wadę, że nie wyświetla zarówno globalnej, jak i lokalnej wartości toc dla oglądanej strony.

Wydaje się, że inni irked o tym ograniczeniu i doprowadziły do ​​dalszego rozwoju rozszerzenie do obsługi pełną toc w pasku bocznym, kasa: https://pypi.python.org/pypi/sphinxcontrib-fulltoc