laraws/phpunit-doc-en repository overview

⁠Translations

Each translation of the documentation is maintained in a separate repository:

• English Documentation⁠
• Spanish Documentation⁠
• French Documentation⁠
• Brazilian Portuguese Documentation⁠
• Japanese Documentation⁠
• Simplified Chinese Documentation⁠
• Russian Documentation⁠

⁠Adding a new translation

If you want to create a new translation, please open an issue in the issue tracker of the English documentation, stating which language you would like to translate. A repository will be created and added to the available translations.

Ideally, you would already have prepared a first version based on a fork or a copy of the English documentation, which will then be imported into the official repository.

⁠Building the Documentation

⁠Requirements

• Python
• Sphinx⁠
• Read the Docs Sphinx Theme⁠

⁠Building the HTML Documentation

To build the complete documentation run:

$ make html

Afterwards you will find the HTML files in build/html.

⁠Proofreading Automation

⁠Setup

$ pip install docutils-ast-writer
$ npm install

⁠Usage

$ ./node_modules/.bin/textlint src