mirror of
https://github.com/inventree/InvenTree.git
synced 2025-06-14 02:55:41 +00:00
Render API docs (#6463)
* Render API docs
* Cleanup broken links
* Re-enable strict mode
* Change json to yaml
* Update docs/docs/api/schema.md
Co-authored-by: Matthias Mair <code@mjmair.com>
* Update docs/docs/api/schema.md
Co-authored-by: Matthias Mair <code@mjmair.com>
* Use neoteroi-mkdocs instead
- seems to render more reliably
* Fix SERVERS section for SPECTACTULAR_SETTINGS
* Script for splitting schema into smaller sections
* Generate an index file for the schema pages
* Move schema.md up one directory
* Fix formatting
* Remove tracked file
* Add hook for rebuilding API schema as part of RTD build
* Extract schema as RTD build step
* install invoke
* export env vars
* remove argparse
* Fix order of operations
* Compress env vars
* Remove custom env vars
- Now configured as part of RTD project
* Migrate db
* Revert "remove argparse"
This reverts commit 4665805340
.
* Post-process generated schema file
* Fix file formatting
* Add note about schema repo
* no message
* Reduce schema overhead
* Ignore generated files
* Delete generated file
* Update .gitignore
* Add extra split for machine integration
* Remove schema files
- These will be auto-generated too
* Generate individual schema .md files
* Re-add .md files
- Need git commit log to work
* Update .gitignore
* Fix for CI test
* patch machine.api
* Revert previous change
* Formatting fix
* Adjust export step
* Bump API version
---------
Co-authored-by: Matthias Mair <code@mjmair.com>
This commit is contained in:
@ -57,6 +57,7 @@ extra_css:
|
||||
- stylesheets/bootstrap.css
|
||||
- stylesheets/splide.min.css
|
||||
- stylesheets/extra.css
|
||||
- stylesheets/neoteroi-mkdocs.css
|
||||
extra_javascript:
|
||||
- javascripts/extra.js
|
||||
- javascripts/fontawesome.js
|
||||
@ -182,6 +183,7 @@ nav:
|
||||
- Extend:
|
||||
- InvenTree API:
|
||||
- Overview: api/api.md
|
||||
- API Schema: api/schema.md
|
||||
- Model Metadata: api/metadata.md
|
||||
- Download Data: api/download.md
|
||||
- Bulk Delete: api/bulk_delete.md
|
||||
@ -225,6 +227,8 @@ nav:
|
||||
|
||||
# Plugins
|
||||
plugins:
|
||||
- neoteroi.mkdocsoad:
|
||||
use_pymdownx: true
|
||||
- include-markdown:
|
||||
opening_tag: "{!"
|
||||
closing_tag: "!}"
|
||||
@ -252,6 +256,8 @@ markdown_extensions:
|
||||
- meta
|
||||
- pymdownx.details
|
||||
- pymdownx.highlight
|
||||
- pymdownx.tabbed:
|
||||
alternate_style: true
|
||||
- pymdownx.superfences:
|
||||
custom_fences:
|
||||
- name: mermaid
|
||||
|
Reference in New Issue
Block a user