Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Fanchengyan committed Aug 19, 2024
1 parent e3d2493 commit 44e0be4
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 6 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@

- **Convenient to use** - You can easily generate a gallery of examples from
your Jupyter Notebooks, Markdown, or reStructuredText files. It works with `MyST` Ecosystem, including [MyST-parser](https://myst-parser.readthedocs.io/en/latest/) and [MyST-NB](https://myst-nb.readthedocs.io/en/latest/), to render markdown or jupyter notebooks in Sphinx documentation.
- **Customizable** - You can customize the gallery configuration, such as the strategy to select the thumbnail, the gallery layout, and the gallery directory.
- **Fast and robust** - It utilizes existing images to generate gallery thumbnails, eliminating code execution delays and potential accidental errors when building gallery.
- **Customizable** - You can customize the gallery, such as thumbnail selection, layout, and styling.

## Documentation

Expand Down
3 changes: 2 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ Highlight Features
------------------

- **Convenient to use** - You can easily generate a gallery of examples from your Jupyter Notebooks, Markdown, or reStructuredText files. It works with ``MyST`` ecosystem, including `MyST-parser <https://myst-parser.readthedocs.io/en/latest/>`_ and `MyST-NB <https://myst-nb.readthedocs.io/en/latest/>`_, to render markdown or jupyter notebooks in Sphinx documentation.
- **Customizable** - You can customize the gallery configuration, such as the strategy to select the thumbnail, the gallery layout, and the gallery directory.
- **Fast and robust** - It utilizes existing images to generate gallery thumbnails, eliminating code execution delays and potential accidental errors when building gallery.
- **Customizable** - You can customize the gallery, such as thumbnail selection, layout, and styling.

.. toctree::
:maxdepth: 2
Expand Down
13 changes: 9 additions & 4 deletions docs/source/user_guide/cross_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ example files in the other documentation files.
Rule for generating targets
---------------------------

**For example files**:
For example files
~~~~~~~~~~~~~~~~~

- removing the number prefix ``dd-`` (if exists) and file suffix.
- converring the letters in the file name to lowercase (target must be small letters).
Expand All @@ -22,10 +23,14 @@ Rule for generating targets
The target is generated based on the file name, so you need to make sure the file name is unique.


**For GALLERY_HEADER.rst file**:
For ``GALLERY_HEADER.rst`` file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The rules are the same as the example files, except that the
**target is generated based on the folder name**.
The rules are the same as the example files, except:

- target is generated based on the folder name.
- adding a suffix ``_header`` to avoid conflict with the example files.
(need version 0.2.2 or later)

.. versionchanged:: 0.2.1

Expand Down

0 comments on commit 44e0be4

Please sign in to comment.