From f12e8b02966747c420f4f608c1b75d9d6e9a9e0c Mon Sep 17 00:00:00 2001 From: weichen Date: Tue, 5 Nov 2019 21:06:07 -0500 Subject: [PATCH] fix some syntax errors Signed-off-by: weichen Change-Id: I8d05a7bfb9554258c99936370b7ae53e042a98bb --- doc-templates/REAMDME.txt | 21 +++++++++++++-------- doc-templates/overview.rst | 4 ++-- 2 files changed, 15 insertions(+), 10 deletions(-) diff --git a/doc-templates/REAMDME.txt b/doc-templates/REAMDME.txt index bfcf6b9..98ec889 100644 --- a/doc-templates/REAMDME.txt +++ b/doc-templates/REAMDME.txt @@ -1,5 +1,5 @@ This README.txt file is a tutorial of how to create repo documentation. -This is a copy&paste solution of documentation, and there is a step-by-step tutorial of creating documentation on https://wiki.o-ran-sc.org/display/DOC. Both solution work, your can choose a way you prefer. +This is a copy&paste solution of documentation, and there is a step-by-step tutorial of creating documentation on https://wiki.o-ran-sc.org/display/DOC/Configure+Repo+for+Documentation. Both solution work, your can choose a way you prefer. Tutorial starts here. @@ -22,14 +22,14 @@ Note: 1. replace your_repo with the repo name you are working on. Step 3: -Choose templates you will have from [api-docs.rst,developer-guide.rst,installation-guide.rst,release-notes.rst,user-guide.rst] for documentation, and finish editing them. +Choose templates you will have from [ api-docs.rst,developer-guide.rst,installation-guide.rst,release-notes.rst,user-guide.rst ] for documentation, and finish editing them. Note: 1. If your don't need any of them, just simply delete the one you do not need. - 2. Teamplates just provide a guideline for documentation. If you have any specific request, please feel free do it yourself. + 2. Templates just provide a guideline for documentation. If you have any specific request, please feel free do it yourself. Step 4: -Editing index.rst. There is a scetion including what rst files your will have in your repo documentaion, something like following: +Editing index.rst. There is a section including what .rst files your will have in your repo documentaion, something like following: ############# example start @@ -63,7 +63,7 @@ Welcome to O-RAN SC your_repo Documentation example ends ############ -Overview.rst is required for each repo while others are optional. Please delete the line (rst files line) you do not need. +Overview.rst is required for each repo while others are optional. Please delete the line (.rst files line) you do not need. For example if you donot need api-docs: @@ -98,17 +98,22 @@ Welcome to O-RAN SC your_repo Documentation example ends ############ +Note: ALL .rst file chapter tile with '====', '----'or any kind of these underline, the underline should be the same length as the text. -Step 5 + +Step 5: Editing overview.rst, there is instruction in the file. Step 6: -Testing your documentation by running 'tox -e docs,docs-linkcheck' command. +Testing your documentation by running 'tox -e docs,docs-linkcheck' command at your_repo/ directory. If everything correct, you can open your_repo/docs/_build/html/index.html to see it locally. Step 7: -upload your documentaion patch +upload your documentaion patch to gerrit + + +If you have any question please contact Weichen Ni (niweichen@chinamobile.com) diff --git a/doc-templates/overview.rst b/doc-templates/overview.rst index f29301e..36434f2 100644 --- a/doc-templates/overview.rst +++ b/doc-templates/overview.rst @@ -1,6 +1,6 @@ -..please write your project overview +..please write your project (repo) overview, better state the relationship with O-RAN alliance. ..please delete this content after editing your_repo Overview -====================== +================== -- 2.16.6