diff --git a/docs/source/development/settings_page.md b/docs/source/development/settings_page.md index 29c722a..41271b9 100644 --- a/docs/source/development/settings_page.md +++ b/docs/source/development/settings_page.md @@ -1,6 +1,6 @@ -# Settings Page +# Configuration Editor -The settings page (viewable here TODO: add link), is an easy-to-use UI for users to edit their auto-archiver settings. +The [configuration editor](../installation/config_editor.md), is an easy-to-use UI for users to edit their auto-archiver settings. The single-file app is built using React and vite. To get started developing the package, follow these steps: @@ -14,7 +14,18 @@ Use `nvm` to manage your node installations. Use: 2. Generate the `schema.json` file for the currently installed modules using `python scripts/generate_settings_schema.py` 3. Go to the settings folder `cd scripts/settings/` and build your environment with `npm i` -4. Run a development version of the page with `npm run dev` +4. Run a development version of the page with `npm run dev` and then open localhost:5173. 5. Build a release version of the page with `npm run build` -A release version creates a single-file app called `dist/index.html` \ No newline at end of file +A release version creates a single-file app called `dist/index.html`. This file should be copied to `docs/source/installation/settings_base.html` so that it can be integrated into the sphinx docs. + +```{note} + +The single-file app dist/index.html does not include any `` or `
` tags as it is designed to be built into a RTD docs page. Edit `index.html` in the settings folder if you wish to modify the built page. +``` + +## Readthedocs Integration + +The configuration editor is built as part of the RTD deployment (see `.readthedocs.yaml` file). This command is run every time RTD is built: + +`cd scripts/settings && npm install && npm run build && yes | cp dist/index.html ../../docs/source/installation/settings_base.html && cd ../..` \ No newline at end of file diff --git a/scripts/settings/index.html b/scripts/settings/index.html index 22ff169..2f7639d 100644 --- a/scripts/settings/index.html +++ b/scripts/settings/index.html @@ -1,3 +1,23 @@ + + + + +