From 623edf3bc907ecb0ee33e6c7289bb4e2969c7485 Mon Sep 17 00:00:00 2001 From: libre-net-society Date: Tue, 12 Jan 2016 07:18:17 +0300 Subject: [PATCH] Tuning docs for Sphinx --- docs/build_notes_unix.md | 19 ++----------------- docs/build_notes_windows.md | 2 +- docs/build_requirements.md | 15 +++++++++++++++ docs/configuration.md | 5 ++++- docs/index.rst | 1 + 5 files changed, 23 insertions(+), 19 deletions(-) create mode 100644 docs/build_requirements.md diff --git a/docs/build_notes_unix.md b/docs/build_notes_unix.md index dc652437..145e1a70 100644 --- a/docs/build_notes_unix.md +++ b/docs/build_notes_unix.md @@ -1,20 +1,5 @@ -Requirements -============ - -Linux/FreeBSD/OSX ------------------ - -GCC 4.6 or newer, Boost 1.46 or newer, openssl, zlib. Clang can be used instead of GCC. - -Windows -------- - -VS2013 (known to work with 12.0.21005.1 or newer), Boost 1.46 or newer, -crypto++ 5.62. See Win32/README-Build.txt for instructions on how to build i2pd -and its dependencies. - -Build notes -=========== +Building on Unix systems +============================= Common build/install process from sources: diff --git a/docs/build_notes_windows.md b/docs/build_notes_windows.md index d1b2f81f..3779eca0 100644 --- a/docs/build_notes_windows.md +++ b/docs/build_notes_windows.md @@ -1,4 +1,4 @@ -Building i2pd on Windows +Building on Windows ========================= There are two approaches available to build i2pd on Windows. The best diff --git a/docs/build_requirements.md b/docs/build_requirements.md new file mode 100644 index 00000000..3f523a80 --- /dev/null +++ b/docs/build_requirements.md @@ -0,0 +1,15 @@ +Build requirements +============ + +Linux/FreeBSD/OSX +----------------- + +GCC 4.6 or newer, Boost 1.46 or newer, openssl, zlib. Clang can be used instead of GCC. + +Windows +------- + +VS2013 (known to work with 12.0.21005.1 or newer), Boost 1.46 or newer, +crypto++ 5.62. See Win32/README-Build.txt for instructions on how to build i2pd +and its dependencies. + diff --git a/docs/configuration.md b/docs/configuration.md index a6de600f..8eb46ce2 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,4 +1,7 @@ -i2pd cmdline options +i2pd configuration +================== + +Command line options -------------------- * --host= - The external IP (deprecated). diff --git a/docs/index.rst b/docs/index.rst index 9d041212..9635d4e4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -22,6 +22,7 @@ Contents: .. toctree:: :maxdepth: 2 + build_requirements build_notes_unix build_notes_windows configuration