Merge pull request #183 from kayjan/mkdocs-add-termynal

Added: mkdocs integration with termynal

Author: kayjan

docs/install.md

@@ -10,20 +10,25 @@ There are two ways to install `bigtree`, with pip (recommended) or conda.
 
 To install `bigtree`, run the following line in command prompt:
 
+<!-- termynal -->
 ```console
 $ pip install bigtree
+---> 100%
+Installed
 ```
 
 If tree needs to use pandas methods, it requires additional dependencies.
 Run the following line in command prompt:
 
+<!-- termynal -->
 ```console
 $ pip install 'bigtree[pandas]'
 ```
 
 If tree needs to be exported to image, it requires additional dependencies.
 Run the following lines in command prompt:
 
+<!-- termynal -->
 ```console
 $ pip install 'bigtree[image]'
 $ brew install gprof2dot  # for MacOS
@@ -32,6 +37,7 @@ $ conda install graphviz  # for Windows
 
 Alternatively, install all optional dependencies with the following line in command prompt:
 
+<!-- termynal -->
 ```console
 $ pip install 'bigtree[all]'
 ```
@@ -40,6 +46,7 @@ $ pip install 'bigtree[all]'
 
 To install `bigtree` with conda, run the following line in command prompt:
 
+<!-- termynal -->
 ```console
 $ conda install -c conda-forge bigtree
 ```

docs/requirements.txt

@@ -7,3 +7,4 @@ mkdocstrings[python]==0.24.0
 pandas
 Pillow
 pydot
+termynal==0.11.1

mkdocs.yml

@@ -113,6 +113,10 @@ plugins:
               merge_init_into_class: true
               docstring_section_style: table
               signature_crossrefs: true
+  - termynal:
+      prompt_literal_start:
+        - "$"
+        - ">"
 
 extra:
   social:

pyproject.toml

@@ -96,6 +96,7 @@ dependencies = [
   "mkdocs-material[imaging]==9.5.5",
   "mdx_truly_sane_lists",
   "mkdocstrings[python]",
+  "termynal",
   "black",
   "IPython",
   "pandas",