Skip to content

Commit 9636c4c

Browse files
committed
Updated the documentation
1 parent 9a9841f commit 9636c4c

20 files changed

+57
-85
lines changed

.readthedocs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
version: 2
2+
23
mkdocs:
3-
configuration: mkdocs.yml
4-
formats: all
4+
configuration: docs/mkdocs.yml
5+
56
python:
6-
version: 3.6
77
install:
88
- requirements: docs/requirements.txt

docs/js/collapsible-navbar.js

Lines changed: 0 additions & 54 deletions
This file was deleted.

docs/mkdocs.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
site_author: dhondta
2+
site_name: "PyBots - Devkit for quickly creating client bots for remote communications"
3+
repo_url: https://github.com/dhondta/python-pybots
4+
copyright: Copyright © 2018-2023 Alexandre D'Hondt
5+
docs_dir: pages
6+
nav:
7+
- Introduction: index.md
8+
- Generalities: generalities.md
9+
- "Core bots": core.md
10+
- "Available API's": apis.md
11+
- "Available bots": bots.md
12+
- "Creating Bots": create.md
13+
- Examples:
14+
- 'Hackvent 2017': examples/hackvent-2017.md
15+
- 'RingZer0': examples/ringzer0.md
16+
- 'Root-Me': examples/rootme.md
17+
extra:
18+
generator: false
19+
social:
20+
- icon: fontawesome/solid/paper-plane
21+
link: mailto:alexandre.dhondt@gmail.com
22+
name: Contact Alex
23+
- icon: fontawesome/brands/github
24+
link: https://github.com/dhondta
25+
name: Alex on GitHub
26+
- icon: fontawesome/brands/linkedin
27+
link: https://www.linkedin.com/in/alexandre-d-2ab2aa14/
28+
name: Alex on LinkedIn
29+
- icon: fontawesome/brands/twitter
30+
link: https://twitter.com/alex_dhondt
31+
name: Alex on Twitter
32+
theme:
33+
name: material
34+
palette:
35+
- scheme: default
36+
toggle:
37+
icon: material/brightness-7
38+
name: Switch to dark mode
39+
- scheme: slate
40+
toggle:
41+
icon: material/brightness-4
42+
name: Switch to light mode
43+
logo: img/logo.png
44+
favicon: img/icon.png
45+
use_directory_urls: false
46+
markdown_extensions:
47+
- toc:
48+
permalink: true
49+
- admonition
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)