Commit Graph

144 Commits

Author SHA1 Message Date
Oliver Walters
c988f9486e Re-order docs index 2019-09-02 17:59:10 +10:00
Oliver Walters
90254d1572 add a note about file encoding 2019-09-02 17:46:42 +10:00
Oliver Walters
37507f2b43 More cleanup of docs 2019-09-02 17:43:20 +10:00
Oliver Walters
47e9c44c43 Prefix correct directory in docs 2019-09-02 17:04:44 +10:00
Oliver Walters
92940f1333 Update makefile docs 2019-09-02 16:05:26 +10:00
Oliver Walters
d30cad2341 Emphasis on config.yaml 2019-09-02 16:05:19 +10:00
Oliver Walters
31f3ead5dc Andrew's eagle eyes 2019-09-02 15:52:19 +10:00
Oliver Walters
4de12033bb Change pip3 to python3-pip 2019-09-02 15:51:58 +10:00
Oliver Walters
e9efac403c Tweak install docs 2019-09-01 22:55:18 +10:00
Oliver Walters
e32048d3c6 Add documentation for data migration 2019-09-01 22:55:02 +10:00
Oliver Walters
d9cc03c5ca Improve installation documentation 2019-09-01 22:16:58 +10:00
Oliver Walters
d0f29ab83b Add note on MySQL collation option 2019-08-15 13:25:47 +10:00
Oliver Walters
475e1681de Doc fix 2019-08-14 12:54:38 +10:00
Oliver Walters
905c02d86f Copy config template to config file if it does not exist 2019-08-14 12:05:47 +10:00
Oliver Walters
0fa5cfdd66 Add doc for mysql installation 2019-08-14 11:32:18 +10:00
Oliver Walters
5ee07eae7c Update installation routine and docs
- Single call of "make install" does everything
- Add backup_dir option to yaml config file
2019-08-01 20:07:06 +10:00
Oliver Walters
31e6aa6906 doc fix 2019-07-12 00:15:47 +10:00
Oliver Walters
04efa2ece8 Add simple deployment documentation 2019-07-12 00:14:40 +10:00
Oliver Walters
07c95f2032 Doc tweaks 2019-07-11 23:15:24 +10:00
Oliver Walters
194c15492f MEDIA_ROOT is now provided in config.yaml 2019-07-10 23:41:33 +10:00
Oliver Walters
e231de6951 Documentation for allowed hosts / CORS headers 2019-07-10 23:33:46 +10:00
Oliver Walters
b941a4115f Documentation for settings file 2019-07-10 23:11:41 +10:00
Diego Herranz
064e09ee02 doc: python3 instead of python
Otherwise, python2 would be used in most systems.
2019-07-02 08:52:01 +01:00
Oliver Walters
2768a7cdf3 Added some docs 2019-06-18 01:49:07 +10:00
Oliver Walters
e28a435c07 Add entry point for order documentation 2019-06-15 17:13:28 +10:00
Oliver Walters
e91aa075b6 Fix a typo 2019-05-09 08:55:25 +10:00
Oliver Walters
a03027ec9b Add makefile option for quick backup 2019-05-07 07:46:29 +10:00
Oliver Walters
1d719f1ad3 Fixed image 2019-05-06 08:19:18 +10:00
Oliver Walters
c6a7d1c243 Added a bunch of developer documentation 2019-05-05 20:13:59 +10:00
Oliver Walters
7c45f8dc24 Remove absolute URL encoding
- Should now work on RTD
2019-04-28 08:11:29 +10:00
Oliver Walters
e512bc6536 Fix for autoapi-dirs 2019-04-28 01:17:28 +10:00
Oliver Walters
aa04941bf1 Add module-level docstrings for each app 2019-04-28 01:05:45 +10:00
Oliver Walters
b0487b33dc Change documentation root url to 'docs' 2019-04-28 00:58:59 +10:00
Oliver Walters
3a43a8ba72 Add custom links to app documentation 2019-04-28 00:57:29 +10:00
Oliver Walters
c87166a49a Prevent auto-addition of toc by autoapi
- Also fix links in sidebar
2019-04-28 00:37:20 +10:00
Oliver Walters
0d8f14d3e2 Add index and modindex to sidebar
- https://stackoverflow.com/questions/25243482/how-to-add-sphinx-generated-index-to-the-sidebar-when-using-read-the-docs-theme
2019-04-28 00:20:27 +10:00
Oliver Walters
4aef8eecea Force TOC to appear in sidebar for each page
- https://stackoverflow.com/questions/18969093/how-to-include-the-toctree-in-the-sidebar-of-each-page#19007358
2019-04-28 00:03:19 +10:00
Oliver Walters
5e6d49102d Add docstring documentation to the main InvenTree app 2019-04-27 21:21:58 +10:00
Oliver Walters
d9169a0dd1 Add docstrings for Build app 2019-04-27 20:35:14 +10:00
Oliver Walters
53ec42af03 Generate documentation from makefile
- Had to change 'docs' to 'documentation' to prevent directory clash
2019-04-27 17:22:23 +10:00
Oliver Walters
ad3defffe3 Use sphinx-autoapi to generate documentation files
- Select which files to ignore
- Only display items with a docstring
2019-04-27 17:19:51 +10:00
Oliver Walters
8d0df6654c Ignore migration files 2019-04-27 16:48:04 +10:00
Oliver Walters
e3440cbb90 Initialize sphinx documentation
- Change theme to sphinx_rtd_theme
- Ignore build files for docs
2019-04-27 16:09:52 +10:00
Oliver Walters
66cf8239fc Add initial requirements for documentation 2019-04-27 15:44:46 +10:00