From 735333e8f6207150fd05c76f44c1e1352688b21c Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Mon, 30 Jun 2014 22:42:43 +0300 Subject: [PATCH 01/12] .travis.yml & requirements.txt: Enable travis for documentation. --- .travis.yml | 10 ++++++++++ requirements.txt | 1 + 2 files changed, 11 insertions(+) create mode 100644 .travis.yml create mode 100644 requirements.txt diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..8b42023 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,10 @@ +language: python +python: + - "2.7" +# command to install dependencies +install: "pip install -q -r requirements.txt --use-mirrors" +# command to run tests +script: sphinx-build -nW -b html -d _build/doctrees . _build/html +# Flags used here, not in `make html`: +# -n Run in nit-picky mode. Currently, this generates warnings for all missing references. +# -W Turn warnings into errors. This means that the build stops at the first warning and sphinx-build exits with exit status 1. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..6966869 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +sphinx From 651b32578262c791e1504605b891ef32f05c8ac9 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Mon, 30 Jun 2014 22:46:06 +0300 Subject: [PATCH 02/12] contribute/translate.rst: fix title underline --- contribute/translate.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contribute/translate.rst b/contribute/translate.rst index 8d98d64..bedc7c1 100644 --- a/contribute/translate.rst +++ b/contribute/translate.rst @@ -118,7 +118,7 @@ translation guide and send me your .po files by mail. You can choose either one of this way to do it. Mikaela's way ------------- +------------- Send the fi.po (or whatever the name is) files one by one as an attachment. Don't forget to tell me what plugin it is. From fbc9bf2cca41067f41f2357bb3773f2e73bb441c Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Mon, 30 Jun 2014 22:51:15 +0300 Subject: [PATCH 03/12] .travis.yml & requirements.txt: some fixes * Install Limnoria. * Don't specify Python version. * I am curious if this is possible. --- .travis.yml | 6 +++--- requirements.txt | 1 + 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 8b42023..98f0df4 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,8 +1,8 @@ language: python -python: - - "2.7" # command to install dependencies -install: "pip install -q -r requirements.txt --use-mirrors" +install: + - "pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/master/requirements.txt" + - "pip install -r requirements.txt" # command to run tests script: sphinx-build -nW -b html -d _build/doctrees . _build/html # Flags used here, not in `make html`: diff --git a/requirements.txt b/requirements.txt index 6966869..1596a53 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,2 @@ sphinx +pip install git+https://github.com/ProgVal/Limnoria.git@testing From c6e7456973d01b666810b0ea54b95afc34cd6b31 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Mon, 30 Jun 2014 22:52:34 +0300 Subject: [PATCH 04/12] .travis.yml: use sudo --- .travis.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index 98f0df4..1d1873d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,8 +1,8 @@ language: python # command to install dependencies install: - - "pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/master/requirements.txt" - - "pip install -r requirements.txt" + - "sudo pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/master/requirements.txt" + - "sudo pip install -r requirements.txt" # command to run tests script: sphinx-build -nW -b html -d _build/doctrees . _build/html # Flags used here, not in `make html`: From 07526f74126888024c4067903c8390ff36f2d0dc Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Mon, 30 Jun 2014 22:54:31 +0300 Subject: [PATCH 05/12] requirements.txt: remove "pip install"... --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 1596a53..d93aaf7 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,2 @@ sphinx -pip install git+https://github.com/ProgVal/Limnoria.git@testing +git+https://github.com/ProgVal/Limnoria.git@testing From 4c092d493517bac0e56e1b4ed13677491d0180d7 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Mon, 30 Jun 2014 23:00:48 +0300 Subject: [PATCH 06/12] .travis.yml: run scripts that shouldn't be used But the notice about not using them was removed anyay. --- .travis.yml | 5 ++++- append_config_doc.py | 0 generate_plugin_doc.py | 0 3 files changed, 4 insertions(+), 1 deletion(-) mode change 100644 => 100755 append_config_doc.py mode change 100644 => 100755 generate_plugin_doc.py diff --git a/.travis.yml b/.travis.yml index 1d1873d..eb3784e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,7 +4,10 @@ install: - "sudo pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/master/requirements.txt" - "sudo pip install -r requirements.txt" # command to run tests -script: sphinx-build -nW -b html -d _build/doctrees . _build/html +script: + - "./generate_plugin_doc.py" + - "./append_config_doc.py" + - "sphinx-build -nW -b html -d _build/doctrees . _build/html" # Flags used here, not in `make html`: # -n Run in nit-picky mode. Currently, this generates warnings for all missing references. # -W Turn warnings into errors. This means that the build stops at the first warning and sphinx-build exits with exit status 1. diff --git a/append_config_doc.py b/append_config_doc.py old mode 100644 new mode 100755 diff --git a/generate_plugin_doc.py b/generate_plugin_doc.py old mode 100644 new mode 100755 From 17f089c7f8526fdc43a7cb6ddc8a12af2fdd069c Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Mon, 30 Jun 2014 23:03:37 +0300 Subject: [PATCH 07/12] Revert ".travis.yml: run scripts that shouldn't be used" This reverts commit 4c092d493517bac0e56e1b4ed13677491d0180d7. --- .travis.yml | 5 +---- append_config_doc.py | 0 generate_plugin_doc.py | 0 3 files changed, 1 insertion(+), 4 deletions(-) mode change 100755 => 100644 append_config_doc.py mode change 100755 => 100644 generate_plugin_doc.py diff --git a/.travis.yml b/.travis.yml index eb3784e..1d1873d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,10 +4,7 @@ install: - "sudo pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/master/requirements.txt" - "sudo pip install -r requirements.txt" # command to run tests -script: - - "./generate_plugin_doc.py" - - "./append_config_doc.py" - - "sphinx-build -nW -b html -d _build/doctrees . _build/html" +script: sphinx-build -nW -b html -d _build/doctrees . _build/html # Flags used here, not in `make html`: # -n Run in nit-picky mode. Currently, this generates warnings for all missing references. # -W Turn warnings into errors. This means that the build stops at the first warning and sphinx-build exits with exit status 1. diff --git a/append_config_doc.py b/append_config_doc.py old mode 100755 new mode 100644 diff --git a/generate_plugin_doc.py b/generate_plugin_doc.py old mode 100755 new mode 100644 From ff51741876493b04793d9419dc9f3815a0883915 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Mon, 30 Jun 2014 23:05:08 +0300 Subject: [PATCH 08/12] develop/index.rst: remove ircdb.rst from library reference. It doesn't appear in generated documentation and makes the builds to fail. --- develop/index.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/develop/index.rst b/develop/index.rst index 02f2788..6a6e10a 100644 --- a/develop/index.rst +++ b/develop/index.rst @@ -37,4 +37,3 @@ Library reference irclib.rst commands.rst ircmsgs.rst - ircdb.rst From 092d250dd1dfc3fd89809bc94d1da802087f71d9 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Mon, 30 Jun 2014 23:09:27 +0300 Subject: [PATCH 09/12] use/index.rst: remove reference to nonexistant ... ...document "use/plugins/index". --- use/index.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/use/index.rst b/use/index.rst index 417487f..2534108 100644 --- a/use/index.rst +++ b/use/index.rst @@ -12,5 +12,4 @@ The Supybot user guide configuration.rst capabilities.rst faq.rst - plugins/index.rst httpserver.rst From 5e70c1460e223c65c0b5ae0a5d96c310ac096834 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Mon, 30 Jun 2014 23:13:19 +0300 Subject: [PATCH 10/12] .travis.yml: install requirements from testing because we are installing Limnoria from testing. This shouldn't affect the build, so [SKIP CI] --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 1d1873d..0568ee0 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,7 +1,7 @@ language: python # command to install dependencies install: - - "sudo pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/master/requirements.txt" + - "sudo pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/testing/requirements.txt" - "sudo pip install -r requirements.txt" # command to run tests script: sphinx-build -nW -b html -d _build/doctrees . _build/html From 583d42a288c10b31172e0f824590fac2a6063974 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Mon, 30 Jun 2014 23:25:38 +0300 Subject: [PATCH 11/12] .travis.yml: update RTFD. --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index 0568ee0..c2c830c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,6 +5,7 @@ install: - "sudo pip install -r requirements.txt" # command to run tests script: sphinx-build -nW -b html -d _build/doctrees . _build/html +after_script: curl -X POST http://readthedocs.org/build/limnoria-doc # Flags used here, not in `make html`: # -n Run in nit-picky mode. Currently, this generates warnings for all missing references. # -W Turn warnings into errors. This means that the build stops at the first warning and sphinx-build exits with exit status 1. From 97484e6929a2bfea79abdd425b3fa2c6e6f69c22 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Fri, 4 Jul 2014 10:29:08 +0300 Subject: [PATCH 12/12] .travis.yml: disable Sphinx errorring until documentation is fixed. --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index c2c830c..b9621cc 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,7 +4,7 @@ install: - "sudo pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/testing/requirements.txt" - "sudo pip install -r requirements.txt" # command to run tests -script: sphinx-build -nW -b html -d _build/doctrees . _build/html +script: sphinx-build -n -b html -d _build/doctrees . _build/html after_script: curl -X POST http://readthedocs.org/build/limnoria-doc # Flags used here, not in `make html`: # -n Run in nit-picky mode. Currently, this generates warnings for all missing references.