From 4b620af0a7c1b34f42241195661627304e993236 Mon Sep 17 00:00:00 2001 From: Ryota MIBU Date: Thu, 26 Nov 2015 23:48:06 +0900 Subject: [PATCH] change dirs to use new opnfv doc build script Change-Id: Icfc17b1370fc111e0e9919f2f1c1d9ea8aee2702 Signed-off-by: Ryota MIBU --- .gitignore | 5 +- Makefile | 44 ----------- design_docs/README => docs/design/index.rst | 11 +++ .../design}/notification-alarm-evaluator.rst | 0 ...st-fault-to-update-server-state-immediately.rst | 0 docs/etc/conf.py | 34 -------- docs/etc/opnfv-logo.png | Bin 2829 -> 0 bytes docs/how-to-use-docs/documentation-example.rst | 86 --------------------- docs/how-to-use-docs/index.rst | 30 ------- docs/manuals/index.rst | 9 +++ .../manuals}/mark-host-down_manual.rst | 10 +++ {requirements => docs/requirements}/01-intro.rst | 0 .../requirements}/02-use_cases.rst | 0 .../requirements}/03-architecture.rst | 0 {requirements => docs/requirements}/04-gaps.rst | 0 .../requirements}/05-implementation.rst | 0 {requirements => docs/requirements}/06-summary.rst | 0 {requirements => docs/requirements}/07-annex.rst | 0 .../requirements}/99-references.rst | 0 {requirements => docs/requirements}/glossary.rst | 0 .../requirements}/images/figure1.png | Bin .../requirements}/images/figure10.png | Bin .../requirements}/images/figure11.png | Bin .../requirements}/images/figure12.png | Bin .../requirements}/images/figure13.png | Bin .../requirements}/images/figure14.png | Bin .../requirements}/images/figure2.png | Bin .../requirements}/images/figure3.png | Bin .../requirements}/images/figure4.png | Bin .../requirements}/images/figure5.png | Bin .../requirements}/images/figure6.png | Bin .../requirements}/images/figure7.png | Bin .../requirements}/images/figure8.png | Bin .../requirements}/images/figure9.png | Bin {requirements => docs/requirements}/index.rst | 14 ---- etc/conf.py | 27 ------- 36 files changed, 33 insertions(+), 237 deletions(-) delete mode 100644 Makefile rename design_docs/README => docs/design/index.rst (73%) rename {design_docs => docs/design}/notification-alarm-evaluator.rst (100%) rename {design_docs => docs/design}/report-host-fault-to-update-server-state-immediately.rst (100%) delete mode 100644 docs/etc/conf.py delete mode 100644 docs/etc/opnfv-logo.png delete mode 100644 docs/how-to-use-docs/documentation-example.rst delete mode 100644 docs/how-to-use-docs/index.rst create mode 100644 docs/manuals/index.rst rename {manuals => docs/manuals}/mark-host-down_manual.rst (93%) rename {requirements => docs/requirements}/01-intro.rst (100%) rename {requirements => docs/requirements}/02-use_cases.rst (100%) rename {requirements => docs/requirements}/03-architecture.rst (100%) rename {requirements => docs/requirements}/04-gaps.rst (100%) rename {requirements => docs/requirements}/05-implementation.rst (100%) rename {requirements => docs/requirements}/06-summary.rst (100%) rename {requirements => docs/requirements}/07-annex.rst (100%) rename {requirements => docs/requirements}/99-references.rst (100%) rename {requirements => docs/requirements}/glossary.rst (100%) rename {requirements => docs/requirements}/images/figure1.png (100%) rename {requirements => docs/requirements}/images/figure10.png (100%) rename {requirements => docs/requirements}/images/figure11.png (100%) rename {requirements => docs/requirements}/images/figure12.png (100%) rename {requirements => docs/requirements}/images/figure13.png (100%) rename {requirements => docs/requirements}/images/figure14.png (100%) rename {requirements => docs/requirements}/images/figure2.png (100%) rename {requirements => docs/requirements}/images/figure3.png (100%) rename {requirements => docs/requirements}/images/figure4.png (100%) rename {requirements => docs/requirements}/images/figure5.png (100%) rename {requirements => docs/requirements}/images/figure6.png (100%) rename {requirements => docs/requirements}/images/figure7.png (100%) rename {requirements => docs/requirements}/images/figure8.png (100%) rename {requirements => docs/requirements}/images/figure9.png (100%) rename {requirements => docs/requirements}/index.rst (90%) delete mode 100644 etc/conf.py diff --git a/.gitignore b/.gitignore index dac82129..84ba68cf 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ -build/ -public/ +/build/ +/output/ +/releng/ diff --git a/Makefile b/Makefile deleted file mode 100644 index 1e06ef3c..00000000 --- a/Makefile +++ /dev/null @@ -1,44 +0,0 @@ -BUILDDIR := build -PUBLICDIR := public -DESIGN_DOCS = $(wildcard design_docs/*.rst) -MANUALS = $(wildcard manuals/*.rst) - -.PHONY: clean html pdf bps man all public - -define index - rm -f $1/index.html - find $1 -type f | while read a; do echo "
  • $${a#$1/}
    • " >> $1/index.html; done -endef - -all: man bps html pdf - $(call index,$(BUILDDIR)) - -public: - rm -rf $(PUBLICDIR) - mkdir -p $(PUBLICDIR) - cp -r $(BUILDDIR)/manuals $(PUBLICDIR)/ - cp -r $(BUILDDIR)/design_docs $(PUBLICDIR)/ - cp -r $(BUILDDIR)/requirements/html $(PUBLICDIR)/ - cp -r $(BUILDDIR)/requirements/latex/*.pdf $(PUBLICDIR)/ - $(call index,$(PUBLICDIR)) - -clean: - rm -rf $(BUILDDIR)/* - -man: - mkdir -p $(BUILDDIR)/manuals - $(foreach f,$(MANUALS),rst2html.py $(f) $(BUILDDIR)/$(f:.rst=.html);) - -bps: $(DESIGN_DOCS) - mkdir -p $(BUILDDIR)/design_docs - $(foreach f,$(DESIGN_DOCS),rst2html.py $(f) $(BUILDDIR)/$(f:.rst=.html);) - -html: - sphinx-build -b html -c etc -d $(BUILDDIR)/doctrees \ - requirements $(BUILDDIR)/requirements/html - -pdf: - sphinx-build -b latex -c etc -d $(BUILDDIR)/doctrees \ - requirements $(BUILDDIR)/requirements/latex - $(MAKE) -C $(BUILDDIR)/requirements/latex \ - LATEXOPTS='--interaction=nonstopmode' all-pdf diff --git a/design_docs/README b/docs/design/index.rst similarity index 73% rename from design_docs/README rename to docs/design/index.rst index f0491cf6..981b7af1 100644 --- a/design_docs/README +++ b/docs/design/index.rst @@ -1,3 +1,7 @@ +**************** +Design Documents +**************** + This is the directory to store design documents which may include draft versions of blueprints written before proposing to upstream OSS communities such as OpenStack, in order to keep the original blueprint as reviewed in @@ -7,3 +11,10 @@ document to find the latest version of the blueprint and status of development in the relevant OSS community. See also https://wiki.opnfv.org/requirements_projects . + +.. toctree:: + :numbered: + :maxdepth: 4 + + report-host-fault-to-update-server-state-immediately.rst + notification-alarm-evaluator.rst diff --git a/design_docs/notification-alarm-evaluator.rst b/docs/design/notification-alarm-evaluator.rst similarity index 100% rename from design_docs/notification-alarm-evaluator.rst rename to docs/design/notification-alarm-evaluator.rst diff --git a/design_docs/report-host-fault-to-update-server-state-immediately.rst b/docs/design/report-host-fault-to-update-server-state-immediately.rst similarity index 100% rename from design_docs/report-host-fault-to-update-server-state-immediately.rst rename to docs/design/report-host-fault-to-update-server-state-immediately.rst diff --git a/docs/etc/conf.py b/docs/etc/conf.py deleted file mode 100644 index 00660351..00000000 --- a/docs/etc/conf.py +++ /dev/null @@ -1,34 +0,0 @@ -import datetime -import sys -import os - -try: - __import__('imp').find_module('sphinx.ext.numfig') - extensions = ['sphinx.ext.numfig'] -except ImportError: - # 'pip install sphinx_numfig' - extensions = ['sphinx_numfig'] - -# numfig: -number_figures = True -figure_caption_prefix = "Fig." - -source_suffix = '.rst' -master_doc = 'index' -pygments_style = 'sphinx' -html_use_index = False - -pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')] -pdf_fit_mode = "shrink" -pdf_stylesheets = ['sphinx','kerning','a4'] -#latex_domain_indices = False -#latex_use_modindex = False - -latex_elements = { - 'printindex': '', -} - -project = u'OPNFV: Template documentation config' -copyright = u'%s, OPNFV' % datetime.date.today().year -version = u'1.0.0' -release = u'1.0.0' diff --git a/docs/etc/opnfv-logo.png b/docs/etc/opnfv-logo.png deleted file mode 100644 index 1519503eba764f7a00877b9b8bdbbd37fd3707c6..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 2829 zcmV+o3-a`dP)3)28sjxMC?FF++Bq$U6w!I|Q zuDk75d^``ll?O5~(CmjEDa)%lO*g>n_g{0#>mC}Gzk+T4rzf9>j53xroI0y~C_9nZ zRT`GLg0kl=wSC&o>6~=+jNzR71<#dp4To_2s0>t*!h`9cI?8$fX~Qs`rR1m400P?y z90%)qtm)id4ONiKpFsI}ZSK@iJ|1rbWk*!DU!d(zDwO-{0ftjgEE_w%;rV)uW5>yH z_exeI%QmujpMCMW4sNM^@?x)fLqOrhd{$9sTgQ`d%yCO<1Iu4R`O_B4UJp!A_62MX zv+dC{T~-}GLx+x;{ijz!sH5z=g`on8=PSHb0@Q#SaG3%t>jDJstyjW^fI6$;(C9VJ zM0+-BvHTu^?J(N@qDGm&V(fERuzosQRFSAa>*vWrfXJ0P?>aF7?>Ukt-*BC%M;idD zR})ZIu_ASxwrtR%$Ly%uwx-ywh|=kCy{aTtUB<3KB~XF4LO2cx3OQ&Lq?yxFVUVVp z0PEI0KSd4M#7I7+3(=OHPzP?sW6{8s*)F2yL=?p|oPJ~?`#D}}PV%!7PnCdm2ZMFk zW>V&_r_iP-9Vh7N0H%W`WFN{S(M)#H$rw-?2dl-hr#TA2Yp8sVw>mO79!D;2$j(C9 zzXy*$kkgBc&!cDaj~~4?%jjHLfvo_Dkm|Ke`S>rtaK&a?_58uB@A@?~_QQr_jA4r% zdo6L~(X+|q1$xR6wDO0o6BtGDy;|9Z8x6|M}356(@zSPXM%I z0Lusl0BW2ws#XdW$sw*J3o5uE4yIuhY3{5zlq-KbOpogcel|5sNqChP?l1?Huz=hO z3SQz!l7IoUeXMDtEbxn7>nNR~-uQD!D>F?@CkV2w46eFk7TlE;cNI&vfdHD!z_ z;-^n$4()d+RT3Nj{MYwKT=-mO$Li`vcN)ExjLy|D=p^S*?wC11I3%$KjPkiq9dic& zD1XFAINVJI`no{?+x)D;i*#V%#b0@^6+U-r5gc9;H_K&CRFHYaqspI@xpfrruA!jPbh-F;K8f!CJmzV zLU^o+ux2fL(BTYxUP&*N3GW6};H`XywCO?Ilt`dZ<@y1lkihEFYh6s!Cok30j1p@| zA*PCL7qX^OJS8L`Cu6zNLM4H9hooAZa`}@)!U0$bFcXy=K$sXnq37#@mx`sb0!4-h zfeLNEv8FIi;>F96e%vf)rl-oBrvk7d@g%V6_BVf7| zS9#?9)}X;>(XRIvx@+2+Chn!X=v9g*FSX8@n+oz`TlVDdw|;)?Qi7qA@?Piv_~kSp zz&N9Wpt$LZ@;^pTT&l=jY6Ntv!S~(!0Ta?)fhieeICo6MH?;1D1P$l8DC}dpX`5a~ zALHCbvB>*ip9$1haUlorIZDD~fXnDY0!+y*J);b_d;*^%R6~F(+Hr^uC68UD{MqKZ zyQ#Xn1?sk9Ky^fF%h*#DhDrm}69BE&;9s04v@Bh*TZP#G|!E+Ltr=`%PvYj2Zzz=`e#qSKRysVIIQ8#7S=4&P4ul z16;dqQw`0;M;E8cz{eLz0YHF%!Pmr+uvP zEG{6yZ@RHP70GX%dWv-m-sHwqFa7pYIh`H<7f$Y9Kl$`$%G98dx#an({(_lPu>y#%;AjQuVEuIY|;4s81w z#Z9+x0(6IfO6rah*C;7Q>2IAZ=A_a?j=YvVm5$`A=Xk(NjTP=x_bf}^Nv%B}fOYWx z-+$w4&SwN*t#-g;MKm(5?=ac1cqys-LMUztGL*=J3S^`(fvTgaU|;f5s$9OWDi9=I z1mFZYUJgA`4`A^D8XT2Wv*9PAp~W{FPBzFLX_p|XyY7n$pqd*&g_%8ysUC{WH7f9A z{3JO6UdmNy&)G-!?s6LASmZx|h}zZ%u#N#NN6`>B>G!PgVok2wT@V%84C-F@)68XM zGW#x-jYI{2;|u+SY#vZP0L5w;Oh|yY!hN&Wg1h=3z#0Nr=i>Rt>A6e%UKe}1!$6_^ zyY2!|KE8hcHS9CJx}hwxL|L2>K%N3nzR5u_jZQK!y-@we@hOeIt`Go*-YJIn>X1b) zcSps7k=C}`RwbZX)CLv6gAir@0^=XP_$PXk@XgyVD}%}x-+6=`IL7!&&~sY=n5Ri( zAYfsMQAU@D!Ifo|}iQURGX*Df~iL*>ymsNDu7Cs_;TR&=~wSP z9+T$^YHUmnj8!iS9oRm+UBb=MKy;;sk-xOF8-RYdS%B~4aLpauf1?pPG zRovzD3f;9+c%BL+9>i4$h%21{H=dY~eDumzpn~LuFa55oXP~o9(&iJ!@#?aOQNC#m ze6EpDkzx5k3v5joGO*Bjy-? nova-compute @@ -69,6 +76,7 @@ CLI for forcing down: nova service-force-down compute1 nova-compute REST API for disabling forced down: +=================================== Parameter explanations: tenant_id: Identifier of the tenant. @@ -103,6 +111,8 @@ REST API for disabling forced down: inary": "nova-compute", "host": "compute1", "forced_down": false}' CLI for disabling forced down: +============================== + nova service-force-down --unset nova-compute Example: diff --git a/requirements/01-intro.rst b/docs/requirements/01-intro.rst similarity index 100% rename from requirements/01-intro.rst rename to docs/requirements/01-intro.rst diff --git a/requirements/02-use_cases.rst b/docs/requirements/02-use_cases.rst similarity index 100% rename from requirements/02-use_cases.rst rename to docs/requirements/02-use_cases.rst diff --git a/requirements/03-architecture.rst b/docs/requirements/03-architecture.rst similarity index 100% rename from requirements/03-architecture.rst rename to docs/requirements/03-architecture.rst diff --git a/requirements/04-gaps.rst b/docs/requirements/04-gaps.rst similarity index 100% rename from requirements/04-gaps.rst rename to docs/requirements/04-gaps.rst diff --git a/requirements/05-implementation.rst b/docs/requirements/05-implementation.rst similarity index 100% rename from requirements/05-implementation.rst rename to docs/requirements/05-implementation.rst diff --git a/requirements/06-summary.rst b/docs/requirements/06-summary.rst similarity index 100% rename from requirements/06-summary.rst rename to docs/requirements/06-summary.rst diff --git a/requirements/07-annex.rst b/docs/requirements/07-annex.rst similarity index 100% rename from requirements/07-annex.rst rename to docs/requirements/07-annex.rst diff --git a/requirements/99-references.rst b/docs/requirements/99-references.rst similarity index 100% rename from requirements/99-references.rst rename to docs/requirements/99-references.rst diff --git a/requirements/glossary.rst b/docs/requirements/glossary.rst similarity index 100% rename from requirements/glossary.rst rename to docs/requirements/glossary.rst diff --git a/requirements/images/figure1.png b/docs/requirements/images/figure1.png similarity index 100% rename from requirements/images/figure1.png rename to docs/requirements/images/figure1.png diff --git a/requirements/images/figure10.png b/docs/requirements/images/figure10.png similarity index 100% rename from requirements/images/figure10.png rename to docs/requirements/images/figure10.png diff --git a/requirements/images/figure11.png b/docs/requirements/images/figure11.png similarity index 100% rename from requirements/images/figure11.png rename to docs/requirements/images/figure11.png diff --git a/requirements/images/figure12.png b/docs/requirements/images/figure12.png similarity index 100% rename from requirements/images/figure12.png rename to docs/requirements/images/figure12.png diff --git a/requirements/images/figure13.png b/docs/requirements/images/figure13.png similarity index 100% rename from requirements/images/figure13.png rename to docs/requirements/images/figure13.png diff --git a/requirements/images/figure14.png b/docs/requirements/images/figure14.png similarity index 100% rename from requirements/images/figure14.png rename to docs/requirements/images/figure14.png diff --git a/requirements/images/figure2.png b/docs/requirements/images/figure2.png similarity index 100% rename from requirements/images/figure2.png rename to docs/requirements/images/figure2.png diff --git a/requirements/images/figure3.png b/docs/requirements/images/figure3.png similarity index 100% rename from requirements/images/figure3.png rename to docs/requirements/images/figure3.png diff --git a/requirements/images/figure4.png b/docs/requirements/images/figure4.png similarity index 100% rename from requirements/images/figure4.png rename to docs/requirements/images/figure4.png diff --git a/requirements/images/figure5.png b/docs/requirements/images/figure5.png similarity index 100% rename from requirements/images/figure5.png rename to docs/requirements/images/figure5.png diff --git a/requirements/images/figure6.png b/docs/requirements/images/figure6.png similarity index 100% rename from requirements/images/figure6.png rename to docs/requirements/images/figure6.png diff --git a/requirements/images/figure7.png b/docs/requirements/images/figure7.png similarity index 100% rename from requirements/images/figure7.png rename to docs/requirements/images/figure7.png diff --git a/requirements/images/figure8.png b/docs/requirements/images/figure8.png similarity index 100% rename from requirements/images/figure8.png rename to docs/requirements/images/figure8.png diff --git a/requirements/images/figure9.png b/docs/requirements/images/figure9.png similarity index 100% rename from requirements/images/figure9.png rename to docs/requirements/images/figure9.png diff --git a/requirements/index.rst b/docs/requirements/index.rst similarity index 90% rename from requirements/index.rst rename to docs/requirements/index.rst index 61046c3f..ae5f2a34 100644 --- a/requirements/index.rst +++ b/docs/requirements/index.rst @@ -1,12 +1,3 @@ -.. - This work is licensed under a Creative Commons Attribution 3.0 Unported - License. - - http://creativecommons.org/licenses/by/3.0/legalcode - -.. title:: - Doctor - **************************************** Doctor: Fault Management and Maintenance **************************************** @@ -41,7 +32,6 @@ Doctor: Fault Management and Maintenance 18.05.2015 Stable version of the Doctor deliverable ========== ===================================================== - .. raw:: latex \newpage @@ -63,7 +53,3 @@ Doctor: Fault Management and Maintenance .. include:: 99-references.rst - - -.. - vim: set tabstop=4 expandtab textwidth=80: diff --git a/etc/conf.py b/etc/conf.py deleted file mode 100644 index 05dbc4d3..00000000 --- a/etc/conf.py +++ /dev/null @@ -1,27 +0,0 @@ -import datetime -import sys -import os - -needs_sphinx = '1.3' - -numfig = True - -source_suffix = '.rst' -master_doc = 'index' -pygments_style = 'sphinx' -html_use_index = False - -pdf_documents = [('index', u'Doctor', u'Doctor Project', u'OPNFV')] -pdf_fit_mode = "shrink" -pdf_stylesheets = ['sphinx','kerning','a4'] -#latex_domain_indices = False -#latex_use_modindex = False - -latex_elements = { - 'printindex': '', -} - -project = u'Doctor: Fault Management and Maintenance' -copyright = u'%s, OPNFV' % datetime.date.today().year -version = u'1.0.0' -release = u'1.0.0' -- 2.16.6