mirror of
https://github.com/inventree/InvenTree.git
synced 2026-11-18 14:07:41 +00:00
feat(docs): preperation for plugin modeling documentation (#13077)
* update descriptions * add subsections * another section * keep nultin seperate * rename * make readme easier to copy * add a seperate overview section like machines * update generated schema page * add missing key * make initial paragraph more objective * add model doc stump * fix typos * fix caps * adjust readme for easier copy paste * update generate step * remove additional doc item
This commit is contained in:
1 parent
9e78e73a7c
commit
f4f5caae2c
10 files changed
+119
-76
No files matched your search
+14
-14
@@ -23,9 +23,9 @@ InvenTree uses [Zensical](https://zensical.org/) to convert [Markdown](https://z
|
||||
|
||||
To build the documentation locally, run these commands as the `inventree` user:
|
||||
|
||||
```
|
||||
$ cd /home/inventree
|
||||
$ source env/bin/activate
|
||||
```bash
|
||||
cd /home/inventree
|
||||
source env/bin/activate
|
||||
```
|
||||
|
||||
!!! info "(env) prefix"
|
||||
@@ -33,9 +33,9 @@ $ source env/bin/activate
|
||||
|
||||
You can now install the additional packages needed to build the documentation:
|
||||
|
||||
```
|
||||
$ cd src
|
||||
$ pip install --require-hashes -r docs/requirements.txt
|
||||
```bash
|
||||
cd src
|
||||
pip install --require-hashes -r docs/requirements.txt
|
||||
```
|
||||
|
||||
## Schema generation
|
||||
@@ -45,8 +45,8 @@ Building the documentation requires extracting the API schema (and settings defi
|
||||
!!! tip
|
||||
This command is only required when building the documentation for the first time, or when changes have been made to the API schema.
|
||||
|
||||
```
|
||||
$ invoke build-docs
|
||||
```bash
|
||||
invoke build-docs
|
||||
```
|
||||
|
||||
You will see output similar to this (truncated for brevity):
|
||||
@@ -67,24 +67,24 @@ Documentation build complete, but zensical build not requested
|
||||
|
||||
To generate the schema files *and* build the static HTML site (in `docs/site/`), including the post-build checks that all settings are documented, run:
|
||||
|
||||
```
|
||||
$ invoke build-docs --build
|
||||
```bash
|
||||
invoke build-docs --build
|
||||
```
|
||||
|
||||
## Viewing the documentation
|
||||
|
||||
Generate the HTML files from the markdown source files, and start the zensical webpage server:
|
||||
|
||||
```
|
||||
$ zensical serve -a localhost:8080 -f docs/mkdocs.yml
|
||||
```bash
|
||||
zensical serve -a localhost:8080 -f docs/mkdocs.yml
|
||||
```
|
||||
|
||||
You can then point your web browser at http://localhost:8080/
|
||||
|
||||
Alternatively, you can use the `invoke` command:
|
||||
|
||||
```
|
||||
$ invoke dev.docs-server
|
||||
```bash
|
||||
invoke dev.docs-server
|
||||
```
|
||||
|
||||
If you need to, use the `-a` option after `zensical serve` or `invoke` to set the address and port. Run `invoke dev.docs-server --help` for details.
|
||||
|
||||
Reference in new issue
Block a user