-Phd T d Z ddlmZ ddlmZ ddlmZ ddlmZ ddl m
Z
m Z m Z m
Z
ddlmZ ddlZdd lmZ dd
lmZ dd lmZ dd lmZ dd
lmZ ddl m Z ddl m Z ddl m!Z! dede"fdZ#dede"de$de"fdZ%e G d d Z&dede"de"ddfd Z'd eddfd Z(dede"d e"fd Z)dS )!z4Methods to build the toctree used in the html pages. ) dataclass)cachecount)dedent)IteratorListTupleUnion)urlparseN)
BeautifulSoup)nodes)Node)toctree)Sphinx)TocTree)_ )traverse_or_findallnodereturnc 2 d| dS )a^ Render a node with HTML tags that activate MathJax processing.
This is meant for use with rendering section titles with math in them, because
math outputs are ignored by pydata-sphinx-theme's header.
related to the behaviour of a normal math node from:
https://github.com/sphinx-doc/sphinx/blob/master/sphinx/ext/mathjax.py#L28
z-\(z \))astext)r s [/var/www/html/test/jupyter/venv/lib/python3.11/site-packages/pydata_sphinx_theme/toctree.pyadd_inline_mathr s XDKKMMWWW apppagename
startdepthc t | j }t j dd dk r ddlm} g || j j | }n| | } || }n# t $ r d}Y nw xY w||fS )zm
Get the name of `pagename`'s ancestor that is rooted `startdepth` levels below the
global root.
N r! r _get_toctree_ancestors) r envsphinx version_info#sphinx.environment.adapters.toctreer% toctree_includesget_toctree_ancestors
IndexError)r r r r r% ancestorsouts r _get_ancestor_pagenamer/ % s
cg G
2A2 &((NNNNNNQ,,SW-ExPPQ 11(;; $
<s " A, , A;:A;c < e Zd ZU dZeed< eed< eed< eed< dS )LinkInfoz#Dataclass to generate toctree data.
is_currenthreftitle is_externalN)__name__
__module__ __qualname____doc__bool__annotations__str r r r1 r1 < sB --
III JJJr r1 templatenamec
d dt f fd
}t dt dt t fd dt f fd
t dt t
f fd t dt t t t f f fd
d d t d
t dt f
fd
}t d dt dt dt dt t t f f fd
}t d dt dt ffd
}dt t ffd }
d< |d< |d< |d< |d< | d< dS ) z9Add functions so Jinja templates can add toctree objects.r r c t | \ }}|dS | dd rdS t ||fi |}|du S )al Check if there's a sidebar TocTree that needs to be rendered.
Parameters:
startdepth : The level of the TocTree at which to start. 0 includes the
entire TocTree for the site; 1 (default) gets the TocTree for the current
top-level section.
kwargs : passed to the Sphinx `toctree` template function.
r r r NT
includehiddenF)r/ getget_nonroot_toctree)r kwargs ancestorname toctree_objr r r s r suppress_sidebar_toctreez7add_toctree_functions..suppress_sidebar_toctreeK s %;h:%
%
%
! k 4 ::ou - - 5
& <
8>
$ r base_idr c 3 X K t d D ]}|dk r| V
| d| V d S )Nr )start-r )rI ns r get_or_create_id_generatorz9add_toctree_functions..get_or_create_id_generatorg sX Q ' 'AAvv
&&1&&&&&& ' 'r c 4 t | S )z
Create an id that is unique from other ids created by this function at build
time.
The function works by sequentially returning "", "-2",
"-3", etc. each time it is called.
)next)rI rN s r unique_html_idz-add_toctree_functions..unique_html_ido s ..w77888r c
t
j } t j dd dk r ddlm} g |
j j }n| }|r |d }nd}
j j
j j
}g }t |t D ]}|j
d D ]\ }}|dk r
|j
d n|}|`d
}
j j | j D ]F} t! | t" j r|t' | z
}/|| z
}Gt+ t- | j }
|
r|n d | } | t3 ||k | ||
d
D ]4} | t3 d| d | d d 5|S )zGenerate informations necessary to generate nav.
Instead of messing with html later, having this as a util function
should make it slightly easier to generate different html snippet for
sidebar or navbar.
Nr! r" r r$ entriesselfparent pathto)r2 r3 r4 r5 theme_external_linksFurlnameT)r r& r' r( r) r% r* r+ tocsconfigroot_docr TocTreeNodeClass
attributestitleschildren
isinstancer mathr r r: r netlocappendr1 )r r% header_pagesactive_header_pageroot_toc
links_datatocr4 pager is_absolute link_href
external_linkr contextr s r _generate_nav_infoz1add_toctree_functions.._generate_nav_infoy s? #'"" rr "f , , R R R R R R
Y 3 3CG4Lh W WXLL"88BBL &!-b!1 !% 7<
34
'x1ABB ! ! C #~i 8
t376>>s~h//t
= E #t 4 = 3 3%dEJ77 3 !_T%:%: :EE !T[[]] 2EE #8D>>#8 9 9 $/ LDD5FWX5Ft5L5L !! $(,>$> & #$/ /
B %%; < M $&u-'/ $
r c B t | } n # t $ r t d| w xY w }g }g }t d }d}d}d}|d| D ]L}| | |j rdnd|||j rd nd
|j |j M|| d D ]R}| | |j rdnd|d z |z d|j rd nd
|j |j Sd
| |fS )a( Return html for navbar and dropdown.
Given the number of links before the dropdown, return the html for the navbar,
as well as the list of links to put in a dropdown.
Returns:
- HTML str for the navbar
- list of HTML str for the dropdown
z'n_links_before_dropdown is not an int: z
nav-itemnav-linkz
dropdown-itemNzcurrent activerW externalinternal)activenav_linknav_itemext_intr3 r4
) int Exception
ValueErrorr rf formatr2 r5 r3 r4 join)
n_links_before_dropdownrj
links_htmllinks_dropdown boilerplatery rx
dropdown_itemlinkrq s
r $_generate_header_nav_before_dropdownzCadd_toctree_functions.._generate_header_nav_before_dropdown s &)*A&B&B # # S:QSS
('))
'
7 7 78
D ""/3F++B % %*.*: JJJ
*
#
6 7 78
D ! !""/3F++B %^m ; *.*: JJJ
*
#
yy$$n44s 0 Morer
dropdown_textc
| \ }}|r? d }d | }|d| dt | d| d| d z
}|S )a Generate top-level links that are meant for the header navigation.
We use this function instead of the TocTree-based one used for the
sidebar because this one is much faster for generating the links and
we don't need the complexity of the full Sphinx TocTree.
This includes two kinds of links:
- Links to pages described listed in the root_doc TocTrees
- External links defined in theme configuration
Additionally it will create a dropdown list for several links after
a cutoff.
Parameters:
n_links_before_dropdown:The number of links to show before nesting the
remaining links in a Dropdown element.
dropdown_text:Text of the dropdown element button.
zpst-nav-more-linksr| z
z5
)r r )r r r. r dropdown_idlinks_dropdown_htmlr rQ s r generate_header_nav_htmlz7add_toctree_functions..generate_header_nav_html s , C B #
^ (.)=>>K"&))N";"; !,
}%% % )
C
r kindshow_nav_levelc |dk r d d i |}nVt | \ }}|t d t ||fi |}j | d }t |d } |dd d
i D ] } | d d | d D ]P} | d r9| d d
}
d|
v r|
dk r| Q| dk r0 |dd D ]+} g | j
d g dd| j
d < ,|dk r| dd di } t | rzt dd }
| D ]e}|j D ]}|j dk r|} n| dd di } | ||g |
j | f|
}t' | t) t+ | D ]#}| d| d D ]}d |d < $|S ) a Return the navigation link structure in HTML.
This is similar to Sphinx's own default TocTree generation, but it is modified
to generate TocTrees for *second*-level pages and below (not supported
by default in Sphinx).
This is used for our sidebar, which starts at the second-level page.
It also modifies the generated TocTree slightly for Bootstrap classes
and structure (via BeautifulSoup).
Arguments are passed to Sphinx "toctree" function (context["toctree"] below).
ref: https://www.sphinx-doc.org/en/master/templating.html#toctree
Parameters:
kind : "sidebar" or "raw". Whether to generate HTML meant for sidebar
navigation ("sidebar") or to return the raw BeautifulSoup object
("raw").
startdepth : The level of the toctree at which to start. By default,
for the navbar uses the normal toctree (`startdepth=0`), and for the
sidebar starts from the second level (`startdepth=1`).
show_nav_level : The level of the navigation bar to toggle as visible on
page load. By default, this level is 1, and only top-level pages are
shown, with drop-boxes to reveal children. Increasing `show_nav_level`
will show child levels as well.
kwargs : passed to the Sphinx `toctree` template function.
Returns:
HTML string (if kind == "sidebar") OR BeautifulSoup object
(if kind == "raw")
r r rA NzTemplate requested to generate a TocTree fragment but no suitable ancestor found to act as root node. Please report this to theme developers.fragment html.parserliclasscurrentrw ar3 #sidebarulF recursivenavz
bd-sidenavpcaptionattrsz
toctree-l0z li.toctree-lz
> detailsopenr= )r/ RuntimeErrorrD builderrender_partialr
rf selectfind decomposer rC find_alllen
next_siblingsr[ new_tagextendr add_collapse_checkboxesranger} )r r r rE html_toctreerF rG toctree_elementsoupr r3 r partcaptionsnew_soupr siblingtoclistiidetailsr rp r s r generate_toctree_htmlz4add_toctree_functions..generate_toctree_html9 s F ??-79-7777LL )?(z) ) ) %L+ #"" 2X|[ .generate_toc_html..add_header_level_recursive s z!781<== ?w 3 3 ?Y ?7 b///
V
V Ew 3 3 E_U__ E7 **277457+I+I5ST9UUUU
V
Vr r r r r z section-navz flex-columnr rs z toc-entryr rt z.toc-h1r z.toc-h2r )r
r rC r r )
r r r r r
h1_headersr4 r. r rp s
@r generate_toc_htmlz0add_toctree_functions..generate_toc_html s 2 WU^];; V V V V V V #"499T??A666 $t** V VBUBFF7B / /UU
U}UBwKK$t** ? ?BIBFF7B / /II[IBwKwws||
?GGCLL >quuWb 1 1 >: >'
[[++
z??a qME<< **
'jj&& C 6>>JKr c dd } dddd}| |vr't d| d| || S ) z8Return the class that aligns the navbar based on config.theme_navbar_aligncontent)zcol-lg-3zcol-lg-9me-auto)rW rW r )rW rW zms-auto)r leftrightz(Theme option navbar_align must be one ofz, got: )rC r keys)align
align_optionsrp s r navbar_align_classz1add_toctree_functions..navbar_align_class s 0)<<:'(
% % 8 %%''8 8058 8
U##r rQ r rH r r r N)r )r r )r r )r ) r} r r< r r r1 r
r r
)r r r> rp doctreerH r r r r r rq rN rQ s `` ` @@@@r add_toctree_functionsr F s
S 8 'C 'HSM ' ' ' U'9 9 9 9 9 9 9 RX R R R R R R R URh :5 sDI~ :5 :5 :5 :5 :5 U:5z @F* *!$*9<* * * * * * * *\ >?e ee "e8;e }c! "e e e e e e e UeN . . . . . . . . U.`
$S
$
$
$
$
$
$ !/G *BG &'*BG &'' a.referencer summaryspanztoctree-toggle presentation)r roler izfa-solid fa-chevron-downzdetails > p.caption)
r rC find_parentr r r contentsrf
select_oneinsert) r elementclassesparentlir toc_linkr r collapsible_section_headings r r r s ===66 d% d%++gr** **4 *EEH
837
i((0 ||D!! 6W5n5 < Z ,,y))w'(((w %%&=>> ( NN1h ' ' ' ,,y))|| ) '
DLLW6P,QLRRSSSt '.&8&89N&O&O# & ;
NN1 9 : : : q'""" $GFOId% d%r rF c | dd d|vs|d sd|d< t |d |d< |j j | }g }t |t D ]/} |j d|| j |d|}|r| | 0|sdS |d } |dd D ] }|
|j | S ) a\ Get the partial TocTree (rooted at `ancestorname`) that dominates `pagename`.
Parameters:
app : Sphinx app.
pagename : Name of the current page (as Sphinx knows it; i.e., its relative path
from the documentation root).
ancestorname : Name of a page that dominates `pagename` and that will serve as the
root of the TocTree fragment.
toctree : A Sphinx TocTree object. Since this is always needed when finding the
ancestorname (see _get_ancestor_pagename), it's more efficient to pass it here to
re-use it.
kwargs : passed to the Sphinx `toctree` template function.
This is similar to `context["toctree"](**kwargs)` (AKA `toctree(**kwargs)` within a
Jinja template), or `TocTree.get_toctree_for()`, which always uses the "root"
doctree (i.e., `doctree = self.env.get_doctree(self.env.config.root_doc)`).
collapseTmaxdepthr )docnamer r Nr r= )
setdefaultr} r& r\ deepcopyr r_ resolver rf r rb )
r r rF r rE ancestor_doctreetoctrees toctree_noderesolved_toctreeresults
r rD rD T s- ( j$''' vj'9 z VJ /00F: {' 5>>@@H ,,<>NOO
.
.
+7?
K
. OO , - - - t
a[F $QRRL 1 1
&/0000 Mr )*r9 dataclassesr functoolsr itertoolsr textwrapr typingr r r
r urllib.parser r' bs4r
docutilsr docutils.nodesr sphinx.addnodesr r_ sphinx.applicationr r) r
sphinx.localer utilsr r< r r} r/ r1 r r rD r= r r r sD : : ! ! ! ! ! ! / / / / / / / / / / / / ! ! ! ! ! !
7 7 7 7 7 7 % % % % % % 7 7 7 7 7 7 & & & & & & $ 3 # 3 3 . `7 `7 `7.1`7 `7 `7 `7 `7F
h%- h%D h% h% h% h%V1 1 1.11 1 1 1 1 1r