File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1- Yii2-user documentation
2- =======================
1+ # Yii2-user documentation
2+
3+ This documentation is based on Yii2-user master branch.
4+
5+ Documentation is rendered by Read The Docs and is available online. You can see online documention
6+ on [ http://yii2-user.readthedocs.org ] ( http://yii2-user.readthedocs.org/en/latest/ ) .
7+
8+
9+ ## Building documentation
10+
11+ Building the documentation requires [ Sphinx] ( http://sphinx-doc.org/ ) .
12+
13+ Descend into the ` docs/ ` directory, and run ` make ` with one of the following
14+ targets:
15+
16+ - ` html ` - build HTML documentation
17+ - ` epub ` - build epub (ebook) documentation (requires
18+ - ` help ` - build Windows help files
19+ - ` info ` - build Unix info pages
20+ - ` latexpdf ` - build PDF documentation (requires a working ` latex ` toolchain)
21+ - ` man ` - build Unix manpages
22+ - ` text ` - build ANSI text manual files
23+
24+ Examples:
25+
26+ ``` bash
27+ $ make html
28+ ```
29+
30+ You can cleanup by running ` make clean ` .
31+
32+ ## Contributing
33+
34+ You can see contributing instructions in [ CONTRIBUTING.md] ( CONTRIBUTING.md )
35+
36+ ## License
37+
38+ Yii2-user documentation is released under the MIT License. See the bundled [ LICENSE.md] ( LICENSE.md ) for details.
You can’t perform that action at this time.
0 commit comments