Skip to content

Commit

Permalink
docs: refresh documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jnikula committed Oct 23, 2024
1 parent 2bf33e6 commit f73063e
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 15 deletions.
12 changes: 10 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'Groovescore Snooker Scoreboard'
project = 'Groovescore'
copyright = '2022-2024, Jani Nikula'
author = 'Jani Nikula'

Expand All @@ -20,14 +20,22 @@

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
# https://alabaster.readthedocs.io/en/stable/customization.html

html_theme = 'alabaster'
html_static_path = ['_static']

html_theme_options = {
'description': 'Groovescore Snooker Scoreboard',
'description': 'Snooker Scoreboard',
'extra_nav_links': {
'Scoreboard App': 'latest.html',
'GitHub Project': 'https://github.com/groovescore/snooker-scoreboard',
}
}

html_sidebars = {
'**': [
'about.html',
'navigation.html',
]
}
38 changes: 25 additions & 13 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,37 @@
Groovescore Snooker Scoreboard
==============================

Launch the latest release of the `Snooker Scoreboard app`_.
Groovescore is a web application for keeping the score of a game of snooker.

The scoreboard app is a fairly simple single-page application. After launching,
internet connection is not required. All state is stored in browser local
storage only, and never sent anywhere. The app currently works best in tablet
size screens in landscape.
Launch the latest release of `Groovescore`_.

.. note::
The scoreboard app is a fairly simple and self-explanatory single-page
application. After launching, internet connection is not required. All data is
stored in browser local storage only, and never sent anywhere. The app currently
works best in tablet size screens in landscape.

The saved games might not work across scoreboard app versions. If you start a
game using one version of the app, please finish it using the same
version. The app version is visible in the URL.
License
-------

If you have any issues, questions or comments about the rules or the scoreboard
app, please see the `Snooker Scoreboard GitHub project page`_.
Groovescore is free software, released under the `GNU Affero General Public
License v3.0 or later`_ (AGPL-3.0-or-later).

.. _Snooker Scoreboard GitHub project page: https://github.com/groovescore/snooker-scoreboard
Contact
-------

If you have any issues, questions or comments about the scoreboard app, please
see the `GitHub project page`_.

.. warning::

Groovescore is still in early stages of development.

.. _Groovescore: latest.html

.. _GNU Affero General Public License v3.0 or later: https://spdx.org/licenses/AGPL-3.0-or-later.html

.. _GitHub project page: https://github.com/groovescore/snooker-scoreboard

.. _Snooker Scoreboard app: latest.html

.. toctree::
:maxdepth: 1
Expand Down

0 comments on commit f73063e

Please sign in to comment.