Skip to content
This repository was archived by the owner on Aug 22, 2023. It is now read-only.

Commit e8cda1d

Browse files
nsdensde
authored
Merge pull request #29 from Fabulously-Optimized/feat/mkdocs
Use mkdocs and add gitpod configuration
2 parents 64794ee + fc84bf6 commit e8cda1d

20 files changed

+608
-23
lines changed

‎.dockerignore

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
site/
2+
logs/
3+
build/
4+
data/
5+
dist/
6+
.*_cache/
7+
*.spec
8+
pyvenv.cfg

‎.github/workflows/docs.yml

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Deploy documentation
2+
on:
3+
push:
4+
branches: [main]
5+
workflow_dispatch:
6+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
12+
# Allow one concurrent deployment
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: true
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout repo
22+
uses: actions/checkout@v3
23+
- name: Setup Pages
24+
id: pages
25+
uses: actions/configure-pages@v2
26+
# This is specifically configured to use the latest stable version of Python
27+
# Assuming we support it
28+
- name: Setup Python 3.10
29+
uses: actions/setup-python@v4
30+
with:
31+
python-version: 3.10
32+
# mkdocs' gh-deploy command uses the 'legacy' method of deploying custom sites to Pages
33+
# which is placing the built files on a gh-pages branch with a .nojekyll.
34+
# (source: https://github.com/mkdocs/mkdocs/blob/master/mkdocs/commands/gh_deploy.py#L127)
35+
# Since then, GitHub has released a way to deploy to Pages directly from Actions.
36+
# Which makes our life a lot easier.
37+
- name: Install dependencies and build
38+
run: |
39+
python -m venv .
40+
pip install mkdocs mkdocstrings[python] mkdocs-material
41+
mkdocs build -d site
42+
- name: Upload built site
43+
uses: actions/upload-pages-artifact@v2
44+
with:
45+
path: site/
46+
47+
deploy:
48+
runs-on: ubuntu-latest
49+
needs: build
50+
environment:
51+
name: github-pages
52+
url: ${{ steps.deployment.outputs.page_url }}
53+
steps:
54+
- name: Deploy to GitHub Pages
55+
id: deployment
56+
uses: actions/deploy-pages@v1

‎.gitpod.Dockerfile

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
FROM gitpod/workspace-python-3.10
2+
3+
RUN sudo upgrade-packages \
4+
&& sudo install-packages python-tk

‎.gitpod.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
image:
2+
file: .gitpod.Dockerfile
3+
vscode:
4+
extensions:
5+
- editorconfig.editorconfig
6+
- ms-python.python
7+
- Vtrois.gitmoji-vscode
8+
tasks:
9+
- name: Install dependencies
10+
init: cd envs/3.10 && pipenv install
11+
gitConfig:
12+
core.eol: "LF"
13+
core.autocrlf: "false"
14+
core.symlinks: "true"
15+

‎README.md

+8
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,18 @@
1010
## Download
1111

1212
<a href="https://github.com/Fabulously-Optimized/vanilla-installer/releases/latest"><img alt="Download on GitHub" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/compact/available/github_vector.svg"></a>
13+
<!-- commented out until we actually publish, if at all
14+
<a href="https://pypi.org/project/vanilla-installer"><img alt="Download from PyPI" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/compact/available/pypi_vector.svg"></a>
15+
-->
1316

1417
## Support & more
1518

1619
<a href="https://discord.gg/yxaXtaQqdB"><img alt="Chat with us on Discord!" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/compact/social/discord-plural_vector.svg"></a>
20+
<a href="https://fabulously-optimized.github.io/vanilla-installer/"><img alt="Read the documentation!" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/compact/documentation/ghpages_vector.svg"></a>
21+
22+
## Issues or suggestions
23+
24+
<a href="https://github.com/Fabulously-Optimized/issues/new/choose"><img alt="Report an issue!" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/compact/social/github-plural_vector.svg">
1725

1826
## Abbreviations
1927

‎docs/changelogs/template.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
1+
<!--markdownlint-ignore-->
2+
# Template
3+
4+
This page serves as a template for new changelogs.
5+
6+
---
7+
18
# v`release-version`
29

310
## New features
411

5-
- New features with references to [issues](https://github.com/Fabulously-Optimized/vanilla-installer/issues/1), [PRs](https://github.com/Fabulously-Optimized/vanilla-installer/pull/10) or [commits](https://github.com/Fabulously-Optimized/vanilla-installer/commit/5bec3f991db31c5ec3c1156060d74c5517e5689c). (#1)
12+
- New features with references to [issues](https://github.com/Fabulously-Optimized/vanilla-installer/issues/15), [PRs](https://github.com/Fabulously-Optimized/vanilla-installer/pull/10) or [commits](https://github.com/Fabulously-Optimized/vanilla-installer/commit/5bec3f991db31c5ec3c1156060d74c5517e5689c). (#1)
613

714
## Bug fixes
815

‎docs/credits.md

+111-18
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
11
# Code Credits
22

3+
## Contributors
4+
5+
* [@Madis0](https://github.com/Madis0)
6+
* Founder of Fabulously Optimized
7+
* Organization
8+
9+
* [@nsde](https://github.com/nsde)
10+
* Lead developer
11+
* Python scripts (GUI etc.)
12+
13+
* [@RaptaG](https://github.com/RaptaG)
14+
* [Shell installation scripts](/install/) (sh) for MacOS and Linux
15+
16+
* [@osfanbuff63](https://github.com/osfanbuff63)
17+
* Updated [Batchfile installation script](/install/windows.bat) for Windows
18+
* Updated various files for formatting improvements and various fixes
19+
20+
* ...other (see README)
21+
322
## Libraries used (and legal notices)
423

524
### [Minecraft Launcher Lib](https://pypi.org/minecraft-launcher-lib)
@@ -86,24 +105,98 @@ Redistribution and use in source and binary forms, with or without modification,
86105

87106
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
88107

89-
## Contributors
90-
91-
* [@Madis0](https://github.com/Madis0)
92-
* Founder of Fabulously Optimized
93-
* Organization
94-
95-
* [@nsde](https://github.com/nsde)
96-
* Lead developer
97-
* Python scripts (GUI etc.)
98-
99-
* [@RaptaG](https://github.com/RaptaG)
100-
* [Shell installation scripts](install/) (sh) for MacOS and Linux
101-
102-
* [@osfanbuff63](https://github.com/osfanbuff63)
103-
* Updated [Batchfile installation script](install/windows.bat) for Windows
104-
* Updated various files for formatting improvements and various fixes
105-
106-
* ...other (see README)
108+
## [mkdocs](https://mkdocs.org)
109+
110+
Copyright © 2014-present, Tom Christie. All rights reserved.
111+
112+
Redistribution and use in source and binary forms, with or
113+
without modification, are permitted provided that the following
114+
conditions are met:
115+
116+
Redistributions of source code must retain the above copyright
117+
notice, this list of conditions and the following disclaimer.
118+
Redistributions in binary form must reproduce the above copyright
119+
notice, this list of conditions and the following disclaimer in
120+
the documentation and/or other materials provided with the
121+
distribution.
122+
123+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
124+
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
125+
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
126+
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
127+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
128+
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
129+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
130+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
131+
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
132+
AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
133+
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
134+
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
135+
POSSIBILITY OF SUCH DAMAGE.
136+
137+
## [mkdocstrings](https://mkdocstrings.github.io)
138+
139+
ISC License
140+
141+
Copyright (c) 2019, Timothée Mazzucotelli
142+
143+
Permission to use, copy, modify, and/or distribute this software for any
144+
purpose with or without fee is hereby granted, provided that the above
145+
copyright notice and this permission notice appear in all copies.
146+
147+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
148+
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
149+
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
150+
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
151+
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
152+
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
153+
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
154+
155+
## mkdocs-material
156+
157+
Copyright (c) 2016-2022 Martin Donath <[email protected]>
158+
159+
Permission is hereby granted, free of charge, to any person obtaining a copy
160+
of this software and associated documentation files (the "Software"), to
161+
deal in the Software without restriction, including without limitation the
162+
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
163+
sell copies of the Software, and to permit persons to whom the Software is
164+
furnished to do so, subject to the following conditions:
165+
166+
The above copyright notice and this permission notice shall be included in
167+
all copies or substantial portions of the Software.
168+
169+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
170+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
171+
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
172+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
173+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
174+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
175+
IN THE SOFTWARE.
176+
177+
## tomli
178+
179+
MIT License
180+
181+
Copyright (c) 2021 Taneli Hukkinen
182+
183+
Permission is hereby granted, free of charge, to any person obtaining a copy
184+
of this software and associated documentation files (the "Software"), to deal
185+
in the Software without restriction, including without limitation the rights
186+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
187+
copies of the Software, and to permit persons to whom the Software is
188+
furnished to do so, subject to the following conditions:
189+
190+
The above copyright notice and this permission notice shall be included in all
191+
copies or substantial portions of the Software.
192+
193+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
194+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
195+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
196+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
197+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
198+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
199+
SOFTWARE.
107200

108201
## Other credits
109202

‎docs/download.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Download
2+
3+
## Stable
4+
5+
You can download a stable version from any of the following sources:
6+
**These are the only official download links. It's recommended to use these. Download from unlisted sources at your own risk.**
7+
8+
<a href="https://github.com/Fabulously-Optimized/vanilla-installer/releases/latest/"><img alt="Download from GitHub" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/compact/available/github_vector.svg"></a>
9+
10+
<!-- commented out until we actually publish, if at all
11+
<a href="https://pypi.org/project/vanilla-installer"><img alt="Download from PyPI" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/compact/available/pypi_vector.svg"></a>
12+
-->

‎docs/for-devs.md

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
## General developing information
44

55
As this project is written in Python, you will need Python installed. The current recommended version is Python 3.10, however it should work on Python 3.8 and anything newer.
6+
We have a [`gitpod`](https://gitpod.io) configuration, so click this to be automatically teleported to gitpod with development all ready for you.
7+
8+
<a href="https://gitpod.io#https://github.com/Fabulously-Optimized/vanilla-installer"><img alt="gitpod" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/compact/supported/gitpod_vector.svg"></a>
69

710
## Project structure
811

‎docs/index.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# VanillaInstaller
2+
3+
4+
5+
<img alt="mkdocs" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/compact/built-with/mkdocs_vector.svg">

‎docs/reference/cli.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# cli.py reference
2+
3+
:::vanilla-installer.cli

‎docs/reference/gui.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# gui.py reference
2+
3+
:::vanilla-installer.gui

‎docs/reference/index.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# API Reference
2+
3+
This is a list of all functions contained in the code.
4+
By module, in order of what would likely be most useful:
5+
6+
- [main.py](main) - Holds the backend of VanillaInstaller. This would likely be the most useful out of the ones here.
7+
- [theme.py](theme) - Holds utility functions for changing between light and dark modes.
8+
- [gui.py](gui) - Holds the GUI code.
9+
- [cli.py](cli) - Holds the CLI code.
10+
- [log.py](log) - Sets up logging.

‎docs/reference/log.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# log.py reference
2+
3+
:::vanilla-installer.log

‎docs/reference/main.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# main.py reference
2+
3+
:::vanilla-installer.main

‎docs/reference/theme.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# theme.py reference
2+
3+
:::vanilla-installer.theme

‎docs/tutorial.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Installation tutorial
2+
3+
<!-- Should this just be a redirect to the FO wiki? -->

‎envs/3.10/Pipfile

+3
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ tomli = "*"
1212

1313
[dev-packages]
1414
pylint = "*"
15+
mkdocs = "*"
16+
mkdocstrings = {extras = ["python"], version = "*"}
17+
mkdocs-material = "*"
1518

1619
[requires]
1720
python_version = "3.10"

0 commit comments

Comments
 (0)