11# Usage
22
3- WARNING : ** This is the documentation for the NEW, EXPERIMENTAL Python handler.**
3+ TIP : ** This is the documentation for the NEW Python handler.**
44To read the documentation for the LEGACY handler,
55go to the [ legacy handler documentation] ( https://mkdocstrings.github.io/python-legacy ) .
66
@@ -17,7 +17,7 @@ Like every handler, the Python handler accepts both **global** and **local** opt
1717
1818Some options are ** global only** , and go directly under the handler's name.
1919
20- - ` import ` : This option is used to import Sphinx-compatible objects inventories from other
20+ - ` import ` : this option is used to import Sphinx-compatible objects inventories from other
2121 documentation sites. For example, you can import the standard library
2222 objects inventory like this:
2323
@@ -138,10 +138,10 @@ so that the current working directory has no impact on the build process:
138138TIP : **This is the recommended method.**
139139
1401401. mkdocs.yml in root, package in root
141- ```
142- 📁 root/
143- ├── 📄 mkdocs.yml
144- └── 📁 package/
141+ ` ` ` tree
142+ root/
143+ mkdocs.yml
144+ package/
145145 ` ` `
146146
147147 ` ` ` yaml title="mkdocs.yml"
@@ -153,11 +153,11 @@ TIP: **This is the recommended method.**
153153 ` ` `
154154
1551551. mkdocs.yml in root, package in subfolder
156- ```
157- 📁 root/
158- ├── 📄 mkdocs.yml
159- └── 📁 src/
160- └── 📁 package/
156+ ` ` ` tree
157+ root/
158+ mkdocs.yml
159+ src/
160+ package/
161161 ` ` `
162162
163163 ` ` ` yaml title="mkdocs.yml"
@@ -169,11 +169,11 @@ TIP: **This is the recommended method.**
169169 ` ` `
170170
1711711. mkdocs.yml in subfolder, package in root
172- ```
173- 📁 root/
174- ├── 📁 docs/
175- │ └── 📄 mkdocs.yml
176- └── 📁 package/
172+ ` ` ` tree
173+ root/
174+ docs/
175+ mkdocs.yml
176+ package/
177177 ` ` `
178178
179179 ` ` ` yaml title="mkdocs.yml"
@@ -185,12 +185,12 @@ TIP: **This is the recommended method.**
185185 ` ` `
186186
1871871. mkdocs.yml in subfolder, package in subfolder
188- ```
189- 📁 root/
190- ├── 📁 docs/
191- │ └── 📄 mkdocs.yml
192- └── 📁 src/
193- └── 📁 package/
188+ ` ` ` tree
189+ root/
190+ docs/
191+ mkdocs.yml
192+ src/
193+ package/
194194 ` ` `
195195
196196 ` ` ` yaml title="mkdocs.yml"
@@ -218,47 +218,47 @@ In Bash and other shells, you can run your command like this
218218(note the prepended `PYTHONPATH=...`) :
219219
2202201. mkdocs.yml in root, package in root
221- ```
222- 📁 root/
223- ├── 📄 mkdocs.yml
224- └── 📁 package/
221+ ` ` ` tree
222+ root/
223+ mkdocs.yml
224+ package/
225225 ` ` `
226226
227227 ` ` ` bash
228228 PYTHONPATH=. mkdocs build # actually not needed, default
229229 ` ` `
230230
2312311. mkdocs.yml in root, package in subfolder
232- ```
233- 📁 root/
234- ├── 📄 mkdocs.yml
235- └── 📁 src/
236- └── 📁 package/
232+ ` ` ` tree
233+ root/
234+ mkdocs.yml
235+ src/
236+ package/
237237 ` ` `
238238
239239 ` ` ` bash
240240 PYTHONPATH=src mkdocs build
241241 ` ` `
242242
2432431. mkdocs.yml in subfolder, package in root
244- ```
245- 📁 root/
246- ├── 📁 docs/
247- │ └── 📄 mkdocs.yml
248- └── 📁 package/
244+ ` ` ` tree
245+ root/
246+ docs/
247+ mkdocs.yml
248+ package/
249249 ` ` `
250250
251251 ` ` ` bash
252252 PYTHONPATH=. mkdocs build -f docs/mkdocs.yml
253253 ` ` `
254254
2552551. mkdocs.yml in subfolder, package in subfolder
256- ```
257- 📁 root/
258- ├── 📁 docs/
259- │ └── 📄 mkdocs.yml
260- └── 📁 src/
261- └── 📁 package/
256+ ` ` ` tree
257+ root/
258+ docs/
259+ mkdocs.yml
260+ src/
261+ package/
262262 ` ` `
263263
264264 ` ` ` bash
0 commit comments