Build and edit documentation — minecraft-launcher-lib 8.0 documentation

# Build and edit documentation

minecraft-launcher-lib uses Sphinx for it’s documentation. The documentation is hosted on Read the Docs. You can find the source files for the documentation in doc folder.

## Plugins

minecraft-launcher-lib uses the following Sphinx plugins:

- sphinx-reredirects: The module documentation has been moved in the modules directory. This Plugin creates redirects, so older links will still work.

- sphinx-notfound-page: Used for setting the custom 404 page.

- sphinx-rtd-dark-mode: Provides the dark theme, that you can turn on by clicking on the button in the bottom right corner.

- sphinx-copybutton: Provides the copy button on the code blocks

- sphinxext-opengraph: Generates Open Graph metadata

These plugins are all completely optional. You can build the documentation without having these plugins installed. The features, that the plugins provide are missing in that case.

## Building

First you need to install Sphinx and the Read the Docs theme:

    pip install sphinx sphinx-rtd-theme

You can also install the plugins, if you want to e.g. test the dark mode.

To build the documentation open a command line in the doc folder and run:

    # Unix based Systems
    make html
    # Windows
    .\make.bat html

Now you can view the documentation by opening _build/html/index.html in your favorite browser.

## Examples

The examples are stored in the examples folder. They are added to the documentation during build. Please do not edit anything inside doc/examples. All files in this folder are overwritten during the build.