SkyKings Documentation Source

Contains the source of https://docs.skykings.net.

For documentation errors, please open an issue.

For modifications to the documentation, feel free to open a pull request.

Editing the Docs

Documentation is built using the Sphinx documentation generator. he documentation is written in Markdown and uses MyST for compatibility with Sphinx. Furo is used for theming the documentation, and sphinxext-opengraph is used to generate open graph attributes to allow embedding the link in various site, such as Twitter and Discord.

Installation

Python 3.10+ is required.

To install dependencies, run the following command:

• On Windows: py -m pip install -r requirements.txt
• On Linux: python3 -m pip install -r requirements.txt

Contributing (Locally)

The documentation is stored in the source directory. index.md is the main page of the documentation, and conf.py contains the configuration for the documentation.

Once you have made your changes, you should preview them. You can use the following command to build the documentation:

Windows:

py -m sphinx -b html source build

Linux:

python3 -m sphinx -b html source build

The documentation will be built in the build directory. You can open the generated index.html file in your browser to preview the documentation.

Once done, make a pull request with your changes.

Contributing (GitHub Web Editor)

You can also edit the documentation directly on GitHub. To do so, click on the file you want to edit, and then click on the pencil icon in the top right corner. Once done, make a pull request with your changes.