2
0
mirror of https://github.com/inventree/InvenTree.git synced 2025-06-14 11:05:41 +00:00

Docs refactor (#9545)

* Refactor / reognaize docs structure

* Refactor plugin docs structure

* More refactoring / cleanup

* Update build images

* Gallery updates

* Order images

* Update part docs

* Settings images

* Stock images

* Reitntroduce gallery

* Add custom icon macro

* Update icons

* Cleanup

* Fix link

* Fix internal links

* Revert some page moves

* Fix links

* Fix links
This commit is contained in:
Oliver
2025-04-22 08:18:32 +10:00
committed by GitHub
parent 9b489911e5
commit 6b08e45eac
240 changed files with 964 additions and 831 deletions

View File

@ -58,6 +58,7 @@ extra_css:
- stylesheets/splide.min.css
- stylesheets/extra.css
- stylesheets/neoteroi-mkdocs.css
- https://cdn.jsdelivr.net/npm/@tabler/icons-webfont@3.31.0/dist/tabler-icons.min.css
extra_javascript:
- javascripts/extra.js
- javascripts/fontawesome.js
@ -72,27 +73,58 @@ extra_javascript:
nav:
- InvenTree:
- InvenTree: index.md
- Features: features.md
- FAQ: faq.md
- Demo: demo.md
- Release Notes: releases/release_notes.md
- Core Concepts:
- Terminology: concepts/terminology.md
- Threat Model: concepts/threat_model.md
- Physical Units: concepts/units.md
- Companies: concepts/company.md
- Custom States: concepts/custom_states.md
- Pricing: concepts/pricing.md
- Threat Model: concepts/threat_model.md
- Project Codes: concepts/project_codes.md
- Barcodes:
- Barcode Support: barcodes/index.md
- Internal Barcodes: barcodes/internal.md
- External Barcodes: barcodes/external.md
- Custom Barcodes: barcodes/custom.md
- Development:
- Contributing: develop/contributing.md
- Devcontainer: develop/devcontainer.md
- React Frontend: develop/react-frontend.md
- Privacy: privacy.md
- Release Notes: releases/release_notes.md
- Project:
- Mobile App:
- Mobile App: app/index.md
- Connect: app/connect.md
- Navigation: app/navigation.md
- Search: app/search.md
- Barcodes: app/barcode.md
- Parts: app/part.md
- Stock: app/stock.md
- Purchase Orders: app/po.md
- Sales Orders: app/so.md
- Settings: app/settings.md
- Privacy: app/privacy.md
- Translation: app/translation.md
- Suggestions: app/issues.md
- InvenTree API:
- Overview: api/index.md
- API Schema: api/schema.md
- Model Metadata: api/metadata.md
- Download Data: api/download.md
- Bulk Delete: api/bulk_delete.md
- Interactive API: api/browse.md
- Python Interface:
- Overview: api/python/index.md
- Currency Support: api/python/currency.md
- Examples: api/python/examples.md
- Project Details:
- Governance: project/governance.md
- Project Security: project/security.md
- Project Security: security.md
- Resources: project/resources.md
- Security: security.md
- Privacy: privacy.md
- Install:
- Introduction: start/intro.md
- Introduction: start/index.md
- Processes: start/processes.md
- Configuration: start/config.md
- Docker:
@ -109,7 +141,7 @@ nav:
- Migrating Data: start/migrate.md
- Advanced Topics: start/advanced.md
- Parts:
- Parts: part/part.md
- Parts: part/index.md
- Creating Parts: part/create.md
- Part Views: part/views.md
- Tracking: part/trackable.md
@ -122,27 +154,32 @@ nav:
- Stocktake: part/stocktake.md
- Notifications: part/notification.md
- Stock:
- Stock Items: stock/stock.md
- Stock Items: stock/index.md
- Stock Status: stock/status.md
- Stock Tracking: stock/tracking.md
- Adjusting Stock: stock/adjust.md
- Stock Expiry: stock/expiry.md
- Stock Ownership: stock/owner.md
- Test Results: stock/test.md
- Build:
- Build Orders: build/build.md
- Build Outputs: build/output.md
- Allocating Stock: build/allocate.md
- Example Build Order: build/example.md
- Bill of Materials: build/bom.md
- Orders:
- Companies: order/company.md
- Purchase Orders: order/purchase_order.md
- Sales Orders: order/sales_order.md
- Return Orders: order/return_order.md
- Project Codes: order/project_codes.md
- Manufacturing:
- Manufacturing: manufacturing/index.md
- Bill of Materials: manufacturing/bom.md
- Build Orders: manufacturing/build.md
- Build Outputs: manufacturing/output.md
- Allocating Stock: manufacturing/allocate.md
- Example Build Order: manufacturing/example.md
- Purchasing:
- Purchasing: purchasing/index.md
- Suppliers: purchasing/supplier.md
- Manufacturers: purchasing/manufacturer.md
- Purchase Orders: purchasing/purchase_order.md
- Sales:
- Sales: sales/index.md
- Customers: sales/customer.md
- Sales Orders: sales/sales_order.md
- Return Orders: sales/return_order.md
- Report:
- Templates: report/templates.md
- Templates: report/index.md
- Template Rendering: report/weasyprint.md
- Template Editor: report/template_editor.md
- Reports: report/report.md
@ -151,7 +188,7 @@ nav:
- Helper Functions: report/helpers.md
- Barcodes: report/barcodes.md
- Sample Templates: report/samples.md
- Admin:
- Administration:
- Global Settings: settings/global.md
- User Settings: settings/user.md
- Reference Patterns: settings/reference.md
@ -168,66 +205,35 @@ nav:
- Background Tasks: settings/tasks.md
- Error Logs: settings/logs.md
- Error Codes: settings/error_codes.md
- App:
- InvenTree App: app/app.md
- Connect: app/connect.md
- Navigation: app/navigation.md
- Search: app/search.md
- Barcodes: app/barcode.md
- Parts: app/part.md
- Stock: app/stock.md
- Purchase Orders: app/po.md
- Sales Orders: app/so.md
- Settings: app/settings.md
- Privacy: app/privacy.md
- Translation: app/translation.md
- Suggestions: app/issues.md
- 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
- Interactive API: api/browse.md
- Python Interface:
- Overview: api/python/python.md
- Currency Support: api/python/currency.md
- Examples: api/python/examples.md
- Barcodes:
- Overview: barcodes/barcodes.md
- Internal Barcodes: barcodes/internal.md
- External Barcodes: barcodes/external.md
- Custom Barcodes: barcodes/custom.md
- Plugins:
- Overview: extend/plugins.md
- Installation: extend/plugins/install.md
- Developing a Plugin: extend/how_to_plugin.md
- Model Metadata: extend/plugins/metadata.md
- Tags: extend/plugins/tags.md
- Unit Test: extend/plugins/test.md
- Plugins:
- Overview: plugins/index.md
- Installation: plugins/install.md
- Developing a Plugin: plugins/how_to.md
- Model Metadata: plugins/metadata.md
- Tags: plugins/tags.md
- Unit Test: plugins/test.md
- Plugin Mixins:
- Action Mixin: extend/plugins/action.md
- API Mixin: extend/plugins/api.md
- App Mixin: extend/plugins/app.md
- Barcode Mixin: extend/plugins/barcode.md
- Currency Mixin: extend/plugins/currency.md
- Data Export Mixin: extend/plugins/export.md
- Event Mixin: extend/plugins/event.md
- Icon Pack Mixin: extend/plugins/icon.md
- Label Printing Mixin: extend/plugins/label.md
- Locate Mixin: extend/plugins/locate.md
- Navigation Mixin: extend/plugins/navigation.md
- Report Mixin: extend/plugins/report.md
- Schedule Mixin: extend/plugins/schedule.md
- Settings Mixin: extend/plugins/settings.md
- URL Mixin: extend/plugins/urls.md
- User Interface Mixin: extend/plugins/ui.md
- Validation Mixin: extend/plugins/validation.md
- Action Mixin: plugins/mixins/action.md
- API Mixin: plugins/mixins/api.md
- App Mixin: plugins/mixins/app.md
- Barcode Mixin: plugins/mixins/barcode.md
- Currency Mixin: plugins/mixins/currency.md
- Event Mixin: plugins/mixins/event.md
- Data Export Mixin: plugins/mixins/export.md
- Icon Pack Mixin: plugins/mixins/icon.md
- Label Printing Mixin: plugins/mixins/label.md
- Locate Mixin: plugins/mixins/locate.md
- Navigation Mixin: plugins/mixins/navigation.md
- Report Mixin: plugins/mixins/report.md
- Schedule Mixin: plugins/mixins/schedule.md
- Settings Mixin: plugins/mixins/settings.md
- URL Mixin: plugins/mixins/urls.md
- User Interface Mixin: plugins/mixins/ui.md
- Validation Mixin: plugins/mixins/validation.md
- Machines:
- Overview: extend/machines/overview.md
- Label Printer: extend/machines/label_printer.md
- Third-Party: extend/integrate.md
- Overview: plugins/machines/overview.md
- Label Printer: plugins/machines/label_printer.md
- Third-Party: plugins/integrate.md
# Plugins
plugins: