Automatic mkdocs build

This commit is contained in:
Juli 2024-08-25 11:41:45 +03:00
parent 54d67f49d2
commit a3c1c59e17
7 changed files with 15 additions and 1449 deletions

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -1 +1 @@
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to MkDocs","text":"<p>For full documentation visit mkdocs.org.</p>"},{"location":"#commands","title":"Commands","text":"<ul> <li><code>mkdocs new [dir-name]</code> - Create a new project.</li> <li><code>mkdocs serve</code> - Start the live-reloading docs server.</li> <li><code>mkdocs build</code> - Build the documentation site.</li> <li><code>mkdocs -h</code> - Print help message and exit.</li> </ul>"},{"location":"#project-layout","title":"Project layout","text":"<pre><code>mkdocs.yml # The configuration file.\ndocs/\n index.md # The documentation homepage.\n ... # Other markdown pages, images and other files.\n</code></pre>"},{"location":"imagebot/","title":"imagebot","text":"<p>A bot to post images to a *key server. Includes an easy way to program a new source for images.</p> <p>Source can be found at Julimiro/imagebot, documentation can be found here.</p>"},{"location":"imagebot/#usage","title":"Usage","text":"<p>*Only required if using danbooru image source,</p> <p>1. Clone the repo <code>git clone https://git.gay/Julimiro/imagebot.git</code> 2. Install modules <code>pip install dotenv requests</code></p> <p>4. Create an account for the bot on your *key server.*</p> <p>5. Generate an api key by navigating to <code>/settings/api</code> of the server and clicking generate access token. Below is a list of permissions the bot needs. After setting the permissions, give the token a name and press done. Make sure to keep note of the token that flashes on screen. - Access your Drive files and folders - Compose or delete notes</p> <p>6. Open the .env file - Change baseurl to your *key instances url including /api. - Change the searchquery to what you want, make sure to keep <code>rating:general order:random</code>. * <code>rating:general</code> keeps it safe for work and <code>order:random</code> ensures a post isnt duplicated(probably) . - Change <code>danbooru_user</code> to the bots danbooru username.* - Change <code>danbooru_apikey</code> to an api key generated by going to your danbooru user page, scrolling own to \"API Key\" and clicking view. * -Change <code>api_key</code> to an your token generated earlier in step 5.. - <code>secret</code> should not be modified yet. - Save the file.</p> <p>7. Run <code>get_apps.py</code>. 8. Enter the output of get_apps.py into the <code>secret</code> option in .env. 9. Now when <code>main.py</code> is ran, an image should be posted.</p>"},{"location":"imagebot/#making-an-image-source","title":"Making an image source","text":"<p>The <code>image_source.py</code> file must have a <code>main</code> function which doesnt take arguments but returns <code>string: post_url, string: image_url, string: artists</code></p>"}]}
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to Juli's documentation","text":"<p>You can see a list of pages on the left.</p> <p>&lt;-----</p>"},{"location":"imagebot/","title":"imagebot","text":"<p>A bot to post images to a *key server. Includes an easy way to program a new source for images.</p> <p>Source can be found at Julimiro/imagebot, documentation can be found here(backup also available).</p>"},{"location":"imagebot/#usage","title":"Usage","text":"<p>*Only required if using danbooru image source,</p> <p>1. Clone the repo <code>git clone https://git.gay/Julimiro/imagebot.git</code> 2. Install modules <code>pip install dotenv requests</code></p> <p>4. Create an account for the bot on your *key server.*</p> <p>5. Generate an api key by navigating to <code>/settings/api</code> of the server and clicking generate access token. Below is a list of permissions the bot needs. After setting the permissions, give the token a name and press done. Make sure to keep note of the token that flashes on screen. - Access your Drive files and folders - Compose or delete notes</p> <p>6. Open the .env file - Change baseurl to your *key instances url including /api. - Change the searchquery to what you want, make sure to keep <code>rating:general order:random</code>. * <code>rating:general</code> keeps it safe for work and <code>order:random</code> ensures a post isnt duplicated(probably) . - Change <code>danbooru_user</code> to the bots danbooru username.* - Change <code>danbooru_apikey</code> to an api key generated by going to your danbooru user page, scrolling own to \"API Key\" and clicking view. * -Change <code>api_key</code> to an your token generated earlier in step 5.. - <code>secret</code> should not be modified yet. - Save the file.</p> <p>7. Run <code>get_apps.py</code>. 8. Enter the output of get_apps.py into the <code>secret</code> option in .env. 9. Now when <code>main.py</code> is ran, an image should be posted.</p>"},{"location":"imagebot/#making-an-image-source","title":"Making an image source","text":"<p>The <code>image_source.py</code> file must have a <code>main</code> function which doesnt take arguments but returns <code>string: post_url, string: image_url, string: artists</code></p>"}]}

View file

@ -1,3 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://docs.julimiro.eu/</loc>
<lastmod>2024-08-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.julimiro.eu/imagebot/</loc>
<lastmod>2024-08-25</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

Binary file not shown.