Docs

Overview¶

You will need to set up a Python environment to create, test, and preview docs changes.

Modifying Docs¶

If you plan to make changes to this documentation, you will need to install the following dependencies first:

• Python 3.9+
• Git

Once done, you should clone this repository:

git clone https://github.com/reactive-python/reactpy-django.git
cd reactpy-django

Then, by running the command below you can:

• Install an editable version of the documentation
• Self-host a test server for the documentation

pip install -r requirements.txt --upgrade

Finally, to verify that everything is working properly, you can manually run the docs preview web server.

cd docs
mkdocs serve

Navigate to http://127.0.0.1:8000 to view a preview of the documentation.

GitHub Pull Request¶

Now, you can create/modify the ReactPy-Django source code, and Pull Request (PR) your changes to our GitHub repository.

To learn how to create GitHub PRs, click here.