mirror
/
auto-archiver
kopia lustrzana https://github.com/bellingcat/auto-archiver
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Fix up TODO plus add comments on integration into RTD page

pull/217/head
Patrick Robertson 2025-03-03 09:18:19 +00:00
rodzic cc14e5cb9f
commit 9845804277
2 zmienionych plików z 35 dodań i 4 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

19
docs/source/development/settings_page.md
Wyświetl plik

@ -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`
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 `<html>` or `<head>` 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 ../..`

20
scripts/settings/index.html
Wyświetl plik

@ -1,3 +1,23 @@
<!-- <!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="initial-scale=1, width=device-width" />
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link
rel="stylesheet"
href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500;700&display=swap"
/>
<title>Auto Archiver Settings</title>
</head>
<body> -->
<!-- No need for html/head markup, this page is designed to be included in a RTD page.
See `settings_page.md` for where this is included. -->
<div id="root"></div>
<script type="module" src="/src/main.tsx"></script>
<!-- </body>
</html> -->