5 Commits

Author	SHA1	Message	Date
Matthias Mair	56b16cb1ac	Backport Docs code links (#7740) ... * Docs code links (#7342) * Update docs - Add note about permission denied error * Add macro for generating link to github code * Implement similar feature for source directory links * Adds helper function for link checking * Allow for specification of "raw" file links * Remove debug statement * Generate list of available invoke tasks (cherry picked from commit 797a0c10df) * auto-detect current branch and use that for links * remove debug logging * style fix * spell fix --------- Co-authored-by: Oliver <oliver.henry.walters@gmail.com>	2024-07-27 14:51:54 +10:00
Oliver	39ba25c5ed	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>	2024-03-02 11:28:37 +11:00
Oliver	433ea4d0de	Documentation Improvements (#4894) ... * Improvements for version banner - Display at the bottom of the page - Simplify text * Use mkdocs version provider * use 'navigation.instant' * Support modern mkdocs features - Much better navigation and improved features * Content changes * Add code to find previous versions * Remove modern python syntax * display output codes * Hide version banner * Extra debug message * update terminology.md	2023-05-25 22:42:16 +10:00
Oliver	50cbaff76d	Fixes for docs building (#4659)	2023-04-22 23:35:25 +10:00
Oliver	2ffd2354eb	Documentation integration (#4653) ... * Add documentation under docs/ directory * Add CI workflow for mkdocs configuration checking * Add documentation issue template * update pip-tools? * Update .gitignore files * Fix .gitignore rules * Improve release notes page * remove references to old repo	2023-04-22 22:40:29 +10:00