@@ -830,9 +830,36 @@ macros may be significant.
830
830
LaTeX macros and environments
831
831
-----------------------------
832
832
833
- Here are some macros from the package file :file: `sphinx.sty ` and class files
834
- :file: `sphinxhowto.cls `, :file: `sphinxmanual.cls `, which have public names
835
- thus allowing redefinitions. Check the respective files for the defaults.
833
+ The "LaTeX package" file :file: `sphinx.sty ` loads various components
834
+ providing support macros (aka commands), and environments, which are used in
835
+ the mark-up produced on output from the ``latex `` builder, before conversion
836
+ to ``pdf `` via the LaTeX toolchain. Also the "LaTeX class" files
837
+ :file: `sphinxhowto.cls ` and :file: `sphinxmanual.cls ` define or customize some
838
+ environments. All of these files can be found in the latex build repertory.
839
+
840
+ Some of these provide facilities not available from pre-existing LaTeX
841
+ packages and work around LaTeX limitations with lists, table cells, verbatim
842
+ rendering, footnotes, etc...
843
+
844
+ Others simply define macros with public names to make overwriting their
845
+ defaults easy via user-added contents to the preamble. We will survey most of
846
+ those public names here, but defaults have to be looked at in their respective
847
+ definition files.
848
+
849
+ .. hint ::
850
+
851
+ Sphinx LaTeX support code is split across multiple smaller-sized files.
852
+ Rather than adding code to the preamble via
853
+ `latex_elements <latex_elements_confval _>`_\ [``'preamble' ``] it is
854
+ also possible to replace entirely one of the component files of Sphinx
855
+ LaTeX code with a custom version, simply by including a modified copy in
856
+ the project source and adding the filename to the
857
+ :confval: `latex_additional_files ` list. Check the LaTeX build repertory
858
+ for the filenames and contents.
859
+
860
+ .. versionchanged :: 4.0.0
861
+ split of :file: `sphinx.sty ` into multiple smaller units, to facilitate
862
+ customization of many aspects simultaneously.
836
863
837
864
.. _latex-macros :
838
865
0 commit comments