Mkdocs plugin for fetching additional .md files based on a fetched list, specifically designed to work with the LambdaFeedback architecture.
Project description
MkDocs Plugin: Evaluation Function Documentation Loader
Mkdocs plugin for fetching additional .md files registered in a db before render. Specifically from a web request which returns all the available evaluation functions endpoints.
This plugin was specifially developped for the LambdaFeedback platform.
NOTE: There is currently no safety checking to make sure downloaded markdown files are valid and able to be rendered, they are simply copied over directly from the evaluation function endpoint
Configuration
Enable plugin in the mkdocs.yml
file:
plugins:
- evaldocsloader:
gql_root_url: "http://127.0.0.1:5050/testingfunctions"
add_to_section: ["Authoring Content", "Evaluation Functions"]
gql_root_url
: GraphQL Endpoint from which a list of evaluation functions be fetched
add_to_section
: Path under which the fetched documentation files should be included. This can be arbirarily long. In this example, functions would appended to content under the "Authoring Content" section in the "Grading Functions" subsection.
Dev Notes
Package can be installed locally using
pip install -e .
I've included a small flask api for testing, it's not relevant to the actual plugin - just for development.
Sources/References
Plugin for loading external markdown files: https://github.com/fire1ce/mkdocs-embed-external-markdown
Template for plugins: https://github.com/byrnereese/mkdocs-plugin-template
File Selection: https://github.com/supcik/mkdocs-select-files
Dealing with new files: https://github.com/oprypin/mkdocs-gen-files/blob/master/mkdocs_gen_files/plugin.py
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for evaldocsloader-0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8833aeea307f74318e6f7b28d845cbf45ec6987d88efadbb5ca54a6cb23c96f7 |
|
MD5 | 8ee732fc0ad82eae96f53ae03ea4a9c6 |
|
BLAKE2b-256 | a007b90f91a17d5264ea5b43acc4929e330ab5c5b5729e0db3a9a41af6da2311 |