diff --git a/docs/source/_static/favicon.png b/docs/source/_static/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..5f1635ee13996952cd9f02eb8c4c622c9b59dbe0 Binary files /dev/null and b/docs/source/_static/favicon.png differ diff --git a/docs/source/_static/logo.png b/docs/source/_static/logo.png index 9c3dd05e07298ef378d0c78069bcc4aa38919917..e2c895211291e37f84785d1ee37f3eb3c36ab2c5 100644 Binary files a/docs/source/_static/logo.png and b/docs/source/_static/logo.png differ diff --git a/docs/source/_templates/indexsidebar.html b/docs/source/_templates/indexsidebar.html index 8921ea4c64504553c15ab09709ca4f0b2dad5b53..e63e3c14f9cf4057259dd829c13b0d13e5835aeb 100644 --- a/docs/source/_templates/indexsidebar.html +++ b/docs/source/_templates/indexsidebar.html @@ -1,6 +1,6 @@

Other resources

diff --git a/docs/source/conf.py b/docs/source/conf.py index e04162131edbf57c814303ac2f86c958fb39d3c9..3d16b09bf89af1bf376c835c4b697d080ca9a013 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -120,7 +120,7 @@ # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -html_favicon = '_static/favicon.ico' +html_favicon = '_static/favicon.png' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/source/guides/contribute.rst b/docs/source/guides/contribute.rst index 0e1f9671afc2dec1bef917eb21bcb0dbea38efa3..1870a33c648a5731be7f6aff160a1f3547830444 100644 --- a/docs/source/guides/contribute.rst +++ b/docs/source/guides/contribute.rst @@ -9,7 +9,7 @@ Write a patch Help yourself with the `documentation `_. -Find an opened issue on `this website `_, or write your own bugfix or feature. +Find an opened issue on `this website `_, or write your own bugfix or feature. Then, once it is necessary, commit with:: $ git commit -a @@ -31,12 +31,12 @@ To aid in verifying Python 3 compatibility, also run:: $ tools/run_tests.sh -3 yourmodulename Perhaps you should also write or fix tests. These tests are automatically run by -`Gitlab CI `_ at each commit and merge requests. +`Gitlab CI `_ at each commit and merge requests. Create a merge request or send a patch -------------------------------------- -The easiest way to send your patch is to create a fork on `the woob gitlab `_ and create a merge +The easiest way to send your patch is to create a fork on `the woob gitlab `_ and create a merge request from there. This way, the code review process is easier and continuous integration is run automatically (see previous section). @@ -45,11 +45,11 @@ previous section). Using the ``git+ssh`` protocol to clone the repository will only work when connected from an IPv6 compatible network: - `$ git clone gitlab@git.woob.tech:woob/woob.git` + `$ git clone gitlab@gitlab.com:woob/woob.git` But it is possible to use the ``git+https`` protocol from everywhere (IPv4 and IPv6 networks): - `$ git clone https://git.woob.tech/woob/woob.git` + `$ git clone https://gitlab.com/woob/woob.git` If you prefer good old email patches, just use diff --git a/docs/source/guides/setup.rst b/docs/source/guides/setup.rst index c0c1a1688a38d52d727eecbf4a969cad56197060..8e964257152f6be4d4ac7d244b1861dd55777063 100644 --- a/docs/source/guides/setup.rst +++ b/docs/source/guides/setup.rst @@ -8,7 +8,7 @@ Git installation Clone a git repository with this command:: - $ git clone https://git.woob.tech/woob/woob.git + $ git clone https://gitlab.com/woob/woob.git We don't want to install woob on the whole system, so we create local directories where we will put symbolic links to sources:: diff --git a/docs/source/guides/tests.rst b/docs/source/guides/tests.rst index bd4a1944676d646de830c68a77d837f91bb5fe18..f290f9ace8e145f43a29c5f7f6079f13420ffb30 100644 --- a/docs/source/guides/tests.rst +++ b/docs/source/guides/tests.rst @@ -21,7 +21,7 @@ Then, it run every method which name starts with ``test_``. .. note:: Some environment variables are available, to use specific backend file or send the test results. Refer to `the - comments in the script `_ for more infos on this. + comments in the script `_ for more infos on this. If a module name is passed as argument, only this module will be tested. For example, to only run ``lutim`` tests::