Skip to content

Commit

Permalink
Update link to documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
twisteroidambassador committed Dec 18, 2018
1 parent 65a5123 commit 21d7d54
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
15 changes: 9 additions & 6 deletions README.md
Expand Up @@ -50,10 +50,11 @@ PYTHONPATH.

## How to use PTs in you own Python program

Start with the Documentation. <-- That's supposed to be a link,
but ReadTheDocs does not support building documentation with Python 3.7
yet, so in the meantime, just check the source code, where all
the important stuff have docstrings.
Start with the [Documentation]. Currently the docs are hosted on
Github Pages and updated manually. When Read The Docs supports building
docs with Python 3.7, the docs will be moved there.

[Documentation]: https://twisteroidambassador.github.io/ptadapter-docs/

## How to create a standalone PT tunnel

Expand All @@ -66,5 +67,7 @@ Otherwise, run:

python -m ptadapter --help

A configuration file should be provided to the script. See the
example configuration file in the source directory for guidance.
A configuration file should be provided to the script.
The [Documentation] contains a detailed guide page, which includes
an example config file with detailed comments; the example config file
can also be found in this repository.
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -30,7 +30,7 @@
keywords='pluggable-transport obfuscation tcp',
project_urls={
'Tracker': 'https://github.com/twisteroidambassador/pluggabletransportadapter/issues',
# 'Documentation': '',
'Documentation': 'https://twisteroidambassador.github.io/ptadapter-docs/',
},
packages=find_packages(),
python_requires='>=3.7',
Expand Down

0 comments on commit 21d7d54

Please sign in to comment.