9
votes

Utilisation de Sphinx, comment puis-je supprimer le titre figurant dans la table de contexte de la barre latérale?

dis que mon quelque chose.rst ressemble à ceci: xxx

après compilation, dans le résultant, quelque chose.html il y aura une table des matières dans la barre latérale qui apparaît comme suit:

mon titre

  1. SECTION
  2. SECTION

    existe un moyen simple de supprimer "mon titre" de la table des matières dans quelque.html ?


0 commentaires

6 Réponses :


2
votes

Si vous essayez de le supprimer de tous vos documents, essayez Personnalisation du modèle par défaut . Sinon, vous devrez modifier le HTML Builder en créant une sous-classe.


2 commentaires

Toute suggestion sur la façon dont je puisse modifier localtoc.html pour supprimer le titre d'apparition ... Je ne peux pas sembler le savoir juste à partir des docs ... merci pour l'aide


Je ne peux pas voir comment vous le feriez en utilisant localtoc.html. Cela contient simplement un titre et un appel à {{TOC}}



3
votes

Le moyen facile consiste à utiliser un type d'objet ignoré par la directive TOC:

.. rubric:: My Title


2 commentaires

Cela brise également le {{TCTREE ()}} (si vous l'utilisez).


Et si nous n'avons pas accès au contenu du document (par exemple, .. include :: x )? Pensez-vous qu'il y a toujours une solution de contournement. Je trouve étrange que Sphinx mélange des titres avec Global Tockee.



1
votes

très tard à cette fête, je sais. J'avais juste eu cette question, nécessaire à Mimic H2 et n'a pas été capable de modifier la feuille de style.

Ma solution a pris fin à l'ajout de HTML brut dans le quelque chose.rst : xxx


1 commentaires

Cela casse le TOC (si vous l'utilisez)



6
votes

J'ai pu résoudre ceci en utilisant le .. RAW :: HTML Méthode comme décrit ci-dessus, avec un léger modification (qui évitait de casser le TOC généré automatiquement). Comme décrit précédemment, si votre fichier ne contient que .. RAW :: html en titres, il brisera le TOC généré automatiquement SPHINX. Cependant, si vous utilisez .. RAW :: html et ajoutez -------------------- ci-dessous , il ne montrera pas sur la navire de navigation de gauche et ne cassera pas la TOC. E. g.

Donc, j'ai finalement compris accidentellement comment obtenir des en-têtes pour ne pas être affichés dans le TOC de gauche. Si votre fichier ne contient que .. RAW :: HTML H2 en titres, il brisera le TOC généré automatiquement SPHINX (comme mentionné dans l'article Stackoverflow). Cependant, si vous utilisez .. RAW :: HTML et -------------------- ci-dessous, Il ne montrera pas sur la navigation de gauche et ne cassera pas la TOC: STAR2: e.g. xxx


1 commentaires

Merci pour le post. En fait, je n'ai eu aucune erreur lorsque j'ai omis le --- .



0
votes

Vous pouvez créer votre propre tag H3.

Pour votre en-tête que vous utilisez: P>

.. |start-h3| raw:: html

     <h3>

.. |end-h3| raw:: html

     </h3>


0 commentaires

0
votes

Il semble que vous parlez d'un TOC local (A "sur cette page" TOC). Malheureusement, Sphinx imprime toujours un titre de document comme premier élément (

  • code>). Les TOC locaux réels (Titres de section) sont tous imbriqués
      code> à l'intérieur du premier titre de document
    • code>. (Oui, c'est gênant.)

      Vous avez deux options: p>

      Si le thème Sphinx actuel a local TOC, vous devez Tweak Produit HTML Markup forte>. Par exemple, en masquant le titre du document utilisant CSS. Copier-coller de https://techwriter.documatt.com/ 2021 / SPHINX-localtoc-supprimer-document-title.html : p> xxx pré>

      alternative peut être de Imprimer manuellement TOC forte>, par exemple Au début d'un document avec le contenu Contenu :: code> directive et son : local: code> option. Exemple de https://restructurétext.documatt.com/element /Contents.html#no-Current-Document-title : p>

      #################################
      Contents without a document title
      #################################
      
      Testing ``contents::`` directive with ``:local:`` flag.
      
      .. contents::
         :local:
      
      **********
      Section L2
      **********
      
      Section L3
      ==========
      


  • 0 commentaires