Quickstart ========== This section contains basic information about **sphinx-btn** to get you started. Installation ------------ Use ``pip`` to install **sphinx-btn** in your environment: .. code-block:: console pip install sphinx-btn Extension setup --------------- After installing **sphinx-btn**, add ``sphinxcontrib.icon`` and ``sphinxcontrib.btn`` to the list of extensions in your ``conf.py`` file: .. code-block:: python extensions = [ #[...] "sphinxcontrib.icon", "sphinxcontrib.btn" ] .. note:: The **sphinx-btn** extention rely on **sphinx-icon** to provide access to the fontawesome 6.3.0 icons font/metadata. Icon directive -------------- You can now add buttons directly in your documentation: .. code-block:: rst I'm a :btn:` fa-folder` btn. I'm a :btn:`` btn. I'm a :btn:`fa-folder` btn. I'm a :btn:` fa-folder` btn. I'm a :btn:`` btn. I'm a :btn:`fa-folder` btn. .. note:: Support is provided for older version of Fontawesome. Documentation using ``fas|far|fab`` or ``fa`` will continue working. Be aware that the icon you want to use may changed name since then. HTML output ----------- In the HTML output, the CSS and JS from Fontawesome 6.3.0 are added to the output in the ```` tag. .. code-block:: html