Permalink
Browse files

Fix a lot of documentation (#675)

  • Loading branch information...
1 parent 5c804d4 commit 16de5ec22caa46a6477cc727b99f1936497818af @Idolf Idolf committed with zachriggle Aug 22, 2016
Showing with 40 additions and 18 deletions.
  1. +1 −1 LICENSE-pwntools.txt
  2. +14 −6 README.md
  3. +3 −3 docs/source/conf.py
  4. +14 −0 docs/source/index.rst
  5. +1 −1 examples/README.md
  6. +1 −1 examples/gen-README.py
  7. +1 −1 extra/docker/Dockerfile
  8. +2 −2 pwnlib/asm.py
  9. +1 −1 pwnlib/testexample.py
  10. +2 −2 setup.py
@@ -13,7 +13,7 @@ directories:
- pwnlib/data/
-Copyright (c) 2015 Gallopsled and Zach Riggle
+Copyright (c) 2015 Gallopsled et al.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
View
@@ -1,10 +1,10 @@
# pwntools - CTF toolkit
![pwntools logo](https://github.com/Gallopsled/pwntools/blob/stable/docs/source/logo.png?raw=true)
-[![Docs latest](https://readthedocs.org/projects/pwntools/badge/?version=latest)](https://pwntools.readthedocs.org/)
-[![Docs 2.2.0](https://readthedocs.org/projects/pwntools/badge/?version=2.2.0)](https://pwntools.readthedocs.org/en/2.2.0)
+[![Docs dev](https://readthedocs.org/projects/pwntools/badge/?version=dev)](https://docs.pwntools.com/en/dev)
+[![Docs beta](https://readthedocs.org/projects/pwntools/badge/?version=beta)](https://docs.pwntools.com/en/beta)
+[![Docs stable](https://readthedocs.org/projects/pwntools/badge/?version=stable)](https://docs.pwntools.com/en/stable)
[![PyPI](https://img.shields.io/pypi/v/pwntools.svg?style=flat)](https://pypi.python.org/pypi/pwntools/)
-[![Gittip](https://img.shields.io/gittip/gallopsled.svg?style=flat)](https://www.gittip.com/gallopsled/)
[![Travis](https://travis-ci.org/Gallopsled/pwntools.svg?branch=stable)](https://travis-ci.org/Gallopsled/pwntools)
[![Coveralls](https://img.shields.io/coveralls/Gallopsled/pwntools/stable.svg)](https://coveralls.io/github/Gallopsled/pwntools?branch=stable)
[![Twitter](https://img.shields.io/badge/twitter-pwntools-4099FF.svg?style=flat)](https://twitter.com/pwntools)
@@ -31,7 +31,7 @@ It will drop you into a clean, Docker-ized container. There is nothing of value
[key]: https://gist.githubusercontent.com/zachriggle/efa2e0080ae6de2e8344/raw/4b503e9db54f009d97477d03d4ba5678471f8ff0/id_rsa
# Documentation
-Our documentation is available at [pwntools.readthedocs.org](https://pwntools.readthedocs.org/)
+Our documentation is available at [docs.pwntools.com](https://docs.pwntools.com/)
To get you started, we've provided some example solutions for past CTF challenges in our [write-ups repository](https://github.com/Gallopsled/pwntools-write-ups).
@@ -44,10 +44,18 @@ Most of the functionality of pwntools is self-contained and Python-only. You sh
```sh
apt-get update
apt-get install python2.7 python-pip python-dev git libssl-dev
-pip install --upgrade git+https://github.com/Gallopsled/pwntools.git
+
+# For cutting edge:
+pip install --upgrade git+https://github.com/Gallopsled/pwntools.git@dev
+
+# If you want early access to the next release to help file bugs:
+pip install --upgrade git+https://github.com/Gallopsled/pwntools.git@beta
+
+# If you just want it to work
+pip install pwntools
```
-However, some of the features (assembling/disassembling foreign architectures) require non-Python dependencies. For more information, see the [complete installation instructions here](https://pwntools.readthedocs.org/en/latest/install.html).
+However, some of the features (assembling/disassembling foreign architectures) require non-Python dependencies. For more information, see the [complete installation instructions here](https://docs.pwntools.com/en/dev/install.html).
# Contribution
View
@@ -75,7 +75,7 @@
# General information about the project.
project = u'pwntools'
-copyright = u'2015, Zach Riggle'
+copyright = u'2016, Gallopsled et al.'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -217,7 +217,7 @@
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'pwntools.tex', u'pwntools Documentation',
- u'2015, Zach Riggle', 'manual'),
+ u'2016, Gallopsled et al.', 'manual'),
]
intersphinx_mapping = {'python': ('https://docs.python.org/2.7', None),
@@ -250,7 +250,7 @@
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'pwntools', u'pwntools Documentation',
- [u'2015, Zach Riggle'], 1)
+ [u'2016, Gallopsled et al.'], 1)
]
# If true, show URL addresses after external links.
View
@@ -5,6 +5,20 @@ pwntools
Written in Python, it is designed for rapid prototyping and development,
and intended to make exploit writing as simple as possible.
+The primary location for this documentation is at docs.pwntools.com_, which uses
+readthedocs_. It comes in three primary flavors:
+
+- Stable_
+- Beta_
+- Dev_
+
+.. _readthedocs: https://readthedocs.org
+.. _docs.pwntools.com: https://docs.pwntools.com
+.. _Stable: https://docs.pwntools.com/en/stable
+.. _Beta: https://docs.pwntools.com/en/beta
+.. _Dev: https://docs.pwntools.com/en/dev
+
+
Getting Started
---------------
View
@@ -4,7 +4,7 @@ the pwntools project.
We have a plan to create a separate repository with examples, primarily
exploits. Until we do so, we recommend new users to look at
-https://pwntools.readthedocs.org, as this is a better overview of our features.
+https://docs.pwntools.com, as this is a better overview of our features.
In no particular order the docstrings for each example:
@@ -11,7 +11,7 @@
We have a plan to create a separate repository with examples, primarily
exploits. Until we do so, we recommend new users to look at
-https://pwntools.readthedocs.org, as this is a better overview of our features.
+https://docs.pwntools.com, as this is a better overview of our features.
In no particular order the docstrings for each example:
@@ -4,7 +4,7 @@
############################################################
FROM ubuntu:trusty
-MAINTAINER Maintainer Zach Riggle
+MAINTAINER Maintainer Gallopsled et al.
RUN apt-get update && apt-get install -y software-properties-common
RUN apt-add-repository --yes ppa:pwntools/binutils
View
@@ -133,7 +133,7 @@ def which_binutils(util):
log.warning("""
Could not find %(util)r installed for %(context)s
Try installing binutils for this architecture:
-https://pwntools.readthedocs.org/en/latest/install/binutils.html
+https://docs.pwntools.com/en/dev/install/binutils.html
""".strip() % locals())
raise Exception('Could not find %(util)r installed for %(context)s' % locals())
@@ -179,7 +179,7 @@ def _assembler():
version = re.search(r' (\d\.\d+)', result).group(1)
if version < '2.19':
log.warn_once('Your binutils version is too old and may not work!\n' + \
- 'Try updating with: https://pwntools.readthedocs.org/en/latest/install/binutils.html\n' + \
+ 'Try updating with: https://docs.pwntools.com/en/dev/install/binutils.html\n' + \
'Reported Version: %r' % result.strip())
@@ -3,7 +3,7 @@
of the functionality. You can also add module-level doctests.
You can see what the documentation for this module will look like here:
-https://pwntools.readthedocs.org/en/latest/testexample.html
+https://docs.pwntools.com/en/dev/testexample.html
The tests for this module are run when the documentation is automatically-generated
by Sphinx. This particular module is invoked by an "automodule" directive, which
View
@@ -76,8 +76,8 @@
entry_points = {'console_scripts': console_scripts},
scripts = glob.glob("bin/*"),
description = "CTF framework and exploit development library.",
- author = "Zach Riggle",
- author_email = "zachriggle@gmail.com",
+ author = "Gallopsled et al.",
+ author_email = "#pwntools @ freenode.net",
url = 'https://pwntools.com',
download_url = "https://pwntools.com/tarball/stable",
install_requires = install_requires,

0 comments on commit 16de5ec

Please sign in to comment.