diff --git a/.gitignore b/.gitignore index 62b900c..b30399e 100644 --- a/.gitignore +++ b/.gitignore @@ -10,4 +10,5 @@ tags .mypy_cache /dist /build -docs/_build \ No newline at end of file +docs/_build +docs/examples \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index e41cf0b..5f874e9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -176,5 +176,9 @@ texinfo_documents = [ 'Miscellaneous'), ] +# -- Sphinx gallery config ------------------------------------------- - +sphinx_gallery_conf = { + 'examples_dirs': ['../examples'], + 'gallery_dirs': ['examples'], +} \ No newline at end of file diff --git a/docs/examples b/docs/examples deleted file mode 120000 index 785887f..0000000 --- a/docs/examples +++ /dev/null @@ -1 +0,0 @@ -../examples/ \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 0ddadb3..c3163a1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -24,7 +24,7 @@ Welcome to Lark's documentation! how_to_use how_to_develop recipes - auto_examples/index + examples/index .. toctree:: diff --git a/examples/README.rst b/examples/README.rst index 977c318..e72cb5b 100644 --- a/examples/README.rst +++ b/examples/README.rst @@ -1,8 +1,7 @@ Examples for Lark ================= -How to run the examples -^^^^^^^^^^^^^^^^^^^^^^^ +**How to run the examples**: After cloning the repo, open the terminal into the root directory of the project, and run the following: