Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Refactor to use mkdocs #549

Merged
merged 1 commit into from
Sep 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Double check that you are running the latest version, see [the releases page](ht

# Check if your issue is in the known issues list

The known issues list is available here: <https://python-eduvpn-client.readthedocs.io/en/latest/knownissues.html>
The known issues list is available here: <https://docs.eduvpn.org/client/linux/known-issues.html>

# OS/Distribution

Expand Down
35 changes: 6 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,13 @@
# Linux eduVPN client
# eduVPN for Linux

This is the GNU/Linux desktop client for eduVPN. It interacts with NetworkManager to set up the VPN and it supports OpenVPN + WireGuard.
This is the Linux desktop client for eduVPN.

Read more about eduVPN on the eduVPN website http://eduvpn.org/.
Read more about the eduVPN project on the eduVPN website https://www.eduvpn.org/.

# Installation
# Documentation

The recommended way to install the eduVPN client for Linux is using one of the packages for your Linux distribution. See the installation document:

https://python-eduvpn-client.readthedocs.io/en/latest/installation.html

# Reporting an issue

To report an issue you can make an issue in this repository:

https://github.com/eduvpn/python-eduvpn-client/issues/new/choose

Make sure to follow the issue template closely.

If you prefer e-mail, you can send one to:

mailto:[email protected]

# Other documentation

The full documentation for this client is available on:

https://python-eduvpn-client.readthedocs.io/

if you're looking for eduVPN server documentation, see:

https://docs.eduvpn.org/
The docs for this client are available on:
https://docs.eduvpn.org/client/linux

# License

Expand Down
3 changes: 1 addition & 2 deletions doc/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
_build/
_static/
/site/
20 changes: 0 additions & 20 deletions doc/Makefile

This file was deleted.

Empty file removed doc/_static/.phony
Empty file.
3 changes: 3 additions & 0 deletions doc/build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#!/bin/sh

mkdocs build
195 changes: 0 additions & 195 deletions doc/conf.py

This file was deleted.

87 changes: 0 additions & 87 deletions doc/developer.rst

This file was deleted.

26 changes: 26 additions & 0 deletions doc/eduvpn_theme/css/screen.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
:root {
--accent: #e24301;
}

div.page-footer {
text-align: center;
font-size: small;
}

@media screen and (min-width: 800px) {
body > header {
background-image: url("../img/eduvpn_logo.png");
background-repeat: no-repeat;
background-position: 5% 50%;
}

@media (prefers-color-scheme: dark) {
body > header {
background-image: url("../img/eduvpn_logo_dark.png");
}
}
}

main a.headerlink {
margin-left: 0.15em;
}
Loading
Loading