This folder contains the source code for building the Align-Anything documentation, which is intended to inform you about how to participate in the development of the Align-Anything documentation.

You only need two simple steps to deploy and render the Align-Anything documentation on your local webpage.

1. Install the dependency

# suppose you are in the root dir of align-anything
cd ./docs
# make sure your python env is activated
pip install -r ./requirements.txt

2. Build the docs with Sphinx

Sphinx is a powerful documentation building tool that allows for web page editing using only Markdown or reStructuredText.

To build the page locally with Sphinx, you only need to run the following under align-anything/docs/ folder:

sphinx-autobuild source source/_build/html

The default port for deployment is 8000. If the port has already n used, you can switch it to another port, i.e., 8080, by passing the --port arguments:

sphinx-autobuild --port 8080 source source/_build/html

Sphinx supports both Markdown and reStructuredText, making it very easy to get started. We have compiled relevant reference resources here to facilitate community contributions.