From 6215ae7ca3098c9d78d1de12bcf9ebdfd15994ca Mon Sep 17 00:00:00 2001 From: Matthieu Kermagoret Date: Mon, 15 Jun 2020 10:31:36 +0200 Subject: [PATCH] enh(doc): rename /docs/ folder to /doc/ to ease generation and pimp conf.py. --- README.md | 2 +- contrib/README.md | 2 +- {docs => doc}/en/Makefile | 0 {docs => doc}/en/conf.py | 6 +++--- {docs => doc}/en/developer/guide.rst | 0 {docs => doc}/en/developer/index.rst | 0 {docs => doc}/en/index.rst | 0 {docs => doc}/en/user/guide.rst | 0 {docs => doc}/en/user/index.rst | 0 {docs => doc}/fr/Makefile | 0 {docs => doc}/fr/conf.py | 6 +++--- {docs => doc}/fr/developer/guide.rst | 0 {docs => doc}/fr/developer/index.rst | 0 {docs => doc}/fr/index.rst | 0 {docs => doc}/fr/user/guide.rst | 0 {docs => doc}/fr/user/index.rst | 0 16 files changed, 8 insertions(+), 8 deletions(-) rename {docs => doc}/en/Makefile (100%) rename {docs => doc}/en/conf.py (99%) rename {docs => doc}/en/developer/guide.rst (100%) rename {docs => doc}/en/developer/index.rst (100%) rename {docs => doc}/en/index.rst (100%) rename {docs => doc}/en/user/guide.rst (100%) rename {docs => doc}/en/user/index.rst (100%) rename {docs => doc}/fr/Makefile (100%) rename {docs => doc}/fr/conf.py (99%) rename {docs => doc}/fr/developer/guide.rst (100%) rename {docs => doc}/fr/developer/index.rst (100%) rename {docs => doc}/fr/index.rst (100%) rename {docs => doc}/fr/user/guide.rst (100%) rename {docs => doc}/fr/user/index.rst (100%) diff --git a/README.md b/README.md index 033031c97..e4236814b 100644 --- a/README.md +++ b/README.md @@ -74,4 +74,4 @@ I can set threshold with options ``--warning`` and ``--critical``: $ perl centreon_plugins.pl --plugin=os::linux::snmp::plugin --mode=load --hostname=127.0.0.1 --snmp-version=2c --snmp-community=public --warning=1,2,3 --critical=2,3,4 OK: Load average: 0.00, 0.00, 0.00 | 'load1'=0.00;0:1;0:2;0; 'load5'=0.00;0:2;0:3;0; 'load15'=0.00;0:3;0:4;0; -For more information or help, please read 'docs/user/guide.rst' or go to http://documentation.centreon.com/docs/centreon-plugins/en/latest/ +For more information or help, please read 'user/guide.rst' or go to https://docs.centreon.com/docs/centreon-plugins/en/latest/ diff --git a/contrib/README.md b/contrib/README.md index a9271584d..3565ccb6e 100644 --- a/contrib/README.md +++ b/contrib/README.md @@ -8,7 +8,7 @@ Compile the wrapper: # gcc -o cwrapper_perl cwrapper_perl.c `perl -MExtUtils::Embed -e ccopts -e ldopts` -Create a fatpack: https://github.com/centreon/centreon-plugins/blob/master/docs/en/user/guide.rst#can-i-have-one-standalone-perl-file- +Create a fatpack: https://github.com/centreon/centreon-plugins/blob/master/doc/en/user/guide.rst#can-i-have-one-standalone-perl-file- Comment following lines in the end of fatpack file: diff --git a/docs/en/Makefile b/doc/en/Makefile similarity index 100% rename from docs/en/Makefile rename to doc/en/Makefile diff --git a/docs/en/conf.py b/doc/en/conf.py similarity index 99% rename from docs/en/conf.py rename to doc/en/conf.py index 827a09e02..c24fb46b1 100644 --- a/docs/en/conf.py +++ b/doc/en/conf.py @@ -52,16 +52,16 @@ master_doc = 'index' # General information about the project. project = u'Centreon Plugins' -copyright = u'2014, Merethis' +copyright = u'2007-2020 Centreon' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '' +version = 'latest' # The full version, including alpha/beta/rc tags. -release = '' +release = 'latest' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/en/developer/guide.rst b/doc/en/developer/guide.rst similarity index 100% rename from docs/en/developer/guide.rst rename to doc/en/developer/guide.rst diff --git a/docs/en/developer/index.rst b/doc/en/developer/index.rst similarity index 100% rename from docs/en/developer/index.rst rename to doc/en/developer/index.rst diff --git a/docs/en/index.rst b/doc/en/index.rst similarity index 100% rename from docs/en/index.rst rename to doc/en/index.rst diff --git a/docs/en/user/guide.rst b/doc/en/user/guide.rst similarity index 100% rename from docs/en/user/guide.rst rename to doc/en/user/guide.rst diff --git a/docs/en/user/index.rst b/doc/en/user/index.rst similarity index 100% rename from docs/en/user/index.rst rename to doc/en/user/index.rst diff --git a/docs/fr/Makefile b/doc/fr/Makefile similarity index 100% rename from docs/fr/Makefile rename to doc/fr/Makefile diff --git a/docs/fr/conf.py b/doc/fr/conf.py similarity index 99% rename from docs/fr/conf.py rename to doc/fr/conf.py index 827a09e02..c24fb46b1 100644 --- a/docs/fr/conf.py +++ b/doc/fr/conf.py @@ -52,16 +52,16 @@ master_doc = 'index' # General information about the project. project = u'Centreon Plugins' -copyright = u'2014, Merethis' +copyright = u'2007-2020 Centreon' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '' +version = 'latest' # The full version, including alpha/beta/rc tags. -release = '' +release = 'latest' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/fr/developer/guide.rst b/doc/fr/developer/guide.rst similarity index 100% rename from docs/fr/developer/guide.rst rename to doc/fr/developer/guide.rst diff --git a/docs/fr/developer/index.rst b/doc/fr/developer/index.rst similarity index 100% rename from docs/fr/developer/index.rst rename to doc/fr/developer/index.rst diff --git a/docs/fr/index.rst b/doc/fr/index.rst similarity index 100% rename from docs/fr/index.rst rename to doc/fr/index.rst diff --git a/docs/fr/user/guide.rst b/doc/fr/user/guide.rst similarity index 100% rename from docs/fr/user/guide.rst rename to doc/fr/user/guide.rst diff --git a/docs/fr/user/index.rst b/doc/fr/user/index.rst similarity index 100% rename from docs/fr/user/index.rst rename to doc/fr/user/index.rst