diff --git a/docs/installation.rst b/docs/installation.rst index 235d086..8dbeb7f 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -9,6 +9,9 @@ only Python's package manager (``pip``) is currently supported, and the installation process may require some system packages to be installed in order for everything to work. + +.. _requirements-and-installation-system-requirements: + System Requirements =================== @@ -21,6 +24,9 @@ slightly differently. The most important thing to know is that you need Python 2.7 or 3. Python 2.6 will never be supported because it's old, ugly, and needs to die. + +.. _requirements-and-installation-distribution-specific-requirements: + Distribution Specific Requirements ---------------------------------- @@ -31,6 +37,9 @@ Distribution Specific Requirements :ref:`Installation:OpenBSD ` and follow the instructions. Everything else is taken care of for you. + +.. _requirements-and-installation-distribution-specific-requirements-debian: + Debian/Ubuntu ............. @@ -49,6 +58,9 @@ comfortable with that, at the very least, you'll need ``pip``: sudo apt-get install python-virtualenv python-pip + +.. _requirements-and-installation-distribution-specific-requirements-centos: + CentOS ...... @@ -74,6 +86,9 @@ you're not comfortable with that, at the very least, you'll need ``pip``: sudo yum install python-virtualenv python-pip + +.. _requirements-and-installation-distribution-specific-requirements-gentoo: + Gentoo ...... @@ -89,6 +104,9 @@ that git is built with curl support: If you're not going bleeding edge, or if you're just going to use SSH to get the code from GitHub, then Gentoo will have everything ready for you. + +.. _requirements-and-installation-distribution-specific-requirements-apple: + Apple OSX ......... @@ -147,6 +165,32 @@ easy: sudo pkg_add py-ripe.atlas.tools +.. _installation-from-freebsd: + +FreeBSD +------- + +FreeBSD has a port ready for you: + +.. code:: bash + +cd /usr/ports/net/py-ripe.atlas.tools +make install + + +.. _installation-from-gentoo: + +Gentoo +------ + +There's an ebuild for Magellan in Portage, so installation is as any other +package: + +.. code:: bash + + sudo emerge ripe-atlas-tools + + .. _installation-from-pypi: From PyPi @@ -210,6 +254,3 @@ same directory as ``setup.py``: .. code:: bash python setup.py install - - -.. _installation-troubleshooting: diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index 79fd0fd..2e65bcb 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -1,9 +1,14 @@ +.. _troubleshooting: + Troubleshooting =============== Sometimes things don't go as planned. In these cases, this page is here to help. + +.. _troubleshooting-insecureplatformwarning: + InsecurePlatformWarning ----------------------- @@ -28,6 +33,9 @@ three options: .. _Suppress the warnings: https://urllib3.readthedocs.org/en/latest/security.html#disabling-warnings + +.. _troubleshooting-saganopensslosx: + Sagan, OpenSSL, and OSX ----------------------- @@ -38,6 +46,9 @@ their machines. Workarounds and proper fixes for this issue can be found in the .. _Sagan installation documentation: https://ripe-atlas-sagan.readthedocs.org/en/latest/installation.html#troubleshooting + +.. _troubleshooting-libyaml: + Complaints from libyaml ----------------------- diff --git a/docs/use.rst b/docs/use.rst index 5436caf..5e67446 100644 --- a/docs/use.rst +++ b/docs/use.rst @@ -247,6 +247,9 @@ Option Arguments Explanation ISO country code probes are located. ============================ ================== ============================== + +.. _use-probes-examples: + Examples -------- @@ -762,6 +765,8 @@ complex query:: --set-nsid-bit --set-rd-bit --set-do-bit --set-cd-bit +.. _use-shortcuts: + Shortcuts ---------