KiBot/docs/source/index.rst

69 lines
1.9 KiB
ReStructuredText

KiBot (formerly KiPlot)
=======================
.. figure:: https://raw.githubusercontent.com/INTI-CMNB/KiBot/master/docs/images/kibot_740x400_logo.png
:alt: KiBot Logo
|Python application| |Coverage Status| |PyPI version| |DOCs status| |Donate|
|doc_id|
**Important for CI/CD**:
- The GitHub actions now use the full/test docker images. So now they include PanDoc and also Blender.
- If you are looking for the GitHub Actions documentation, and you already know how
to use KiBot, or want a quick start, read: :ref:`usage-of-github-actions`
**New on v1.6.4**
- KiRi (interactive diff) and KiCanvas (on-line schematic/PCB browser) new outputs
- New Internal templates: 3DRender_top, 3DRender_top_straight, 3DRender_bottom and
3DRender_bottom_straight: to generate simple and quick 3D renders.
- Various fixes and new command line options
.. toctree::
:maxdepth: 3
:caption: Contents:
introduction
installation
configuration
usage
usage_with_ci_cd
.. toctree::
:maxdepth: 3
:caption: Notes and extra information:
notes_gerber
notes_position
notes_3d
propose
KiPlotYAML
Changelog
.. toctree::
:maxdepth: 2
:caption: Final notes:
contributing
credits
.. toctree::
:maxdepth: 2
:caption: Indices and tables:
genindex
.. |Coverage Status| image:: https://img.shields.io/coveralls/github/INTI-CMNB/KiBot?style=plastic&logo=coveralls
:target: https://coveralls.io/github/INTI-CMNB/KiBot?branch=master
.. |PyPI version| image:: https://img.shields.io/pypi/v/kibot?style=plastic&logo=pypi
:target: https://pypi.org/project/kibot/
.. |Donate| image:: https://img.shields.io/badge/Donate-PayPal-green.svg?style=plastic&logo=paypal
:target: https://www.paypal.com/donate/?hosted_button_id=K2T86GDTTMRPL
.. |DOCs status| image:: https://img.shields.io/readthedocs/kibot?style=plastic&logo=readthedocs
:target: https://kibot.readthedocs.io/en/latest/
:alt: Documentation Status