mirror of
https://github.com/drwhut/tabletop-club.git
synced 2025-05-05 15:32:56 +00:00
47 lines
1.3 KiB
ReStructuredText
47 lines
1.3 KiB
ReStructuredText
.. Tabletop Club documentation master file, created by
|
|
sphinx-quickstart on Mon Mar 1 16:14:43 2021.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Tabletop Club Documentation
|
|
===========================
|
|
|
|
Welcome to the documentation for Tabletop Club, a free and open source tabletop
|
|
board game simulator! If you're new to the project, feel free to check out the
|
|
:ref:`about-tabletop-club` page. Otherwise, you can use either the table of
|
|
contents, the sidebar, or the search bar to find what you need!
|
|
|
|
.. image:: ../screenshots.jpg
|
|
:alt: Screenshots from the game
|
|
|
|
.. note::
|
|
|
|
The documentation, as well as the project in general, is open to suggestions
|
|
and contributions! If you feel that something is not explained well, or you
|
|
think that information is missing, then please don't hesitate to open an
|
|
issue or a pull request on the project's `GitHub repository
|
|
<https://github.com/drwhut/tabletop-club/issues>`_!
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: General
|
|
|
|
general/about.rst
|
|
general/download/index.rst
|
|
general/contributing/index.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Custom Assets
|
|
|
|
custom_assets/asset_packs/index.rst
|
|
custom_assets/tutorials/index.rst
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|