You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@age.apache.org by pd...@apache.org on 2022/06/07 08:16:15 UTC
[incubator-age-website] branch pdpotter-create-documentation created (now 9716eda)
This is an automated email from the ASF dual-hosted git repository.
pdpotter pushed a change to branch pdpotter-create-documentation
in repository https://gitbox.apache.org/repos/asf/incubator-age-website.git
at 9716eda Update create documentation section
This branch includes the following new commits:
new 9716eda Update create documentation section
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[incubator-age-website] 01/01: Update create documentation section
Posted by pd...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
pdpotter pushed a commit to branch pdpotter-create-documentation
in repository https://gitbox.apache.org/repos/asf/incubator-age-website.git
commit 9716edab84ec0b26db4b40b78f17bd7c43cc283d
Author: Pieterjan De Potter <pi...@ugent.be>
AuthorDate: Tue Jun 7 10:16:10 2022 +0200
Update create documentation section
---
index.html | 16 +---------------
1 file changed, 1 insertion(+), 15 deletions(-)
diff --git a/index.html b/index.html
index 67452fe..9602c43 100644
--- a/index.html
+++ b/index.html
@@ -1260,21 +1260,7 @@ void f(void)
<!-- BEGIN CREATE DOCS -->
<a id="createdocs"></a>
<div class="heading"><h2>Creating Documentation</h2></div>
- <ul>
- <li>Dependencies: python3, python3-sphinx, sphinx_rtd_theme</li>
- <li>Clone incubator-age repository (AGE) (https://github.com/apache/incubator-age)</li>
- <li>Go to the doc folder of the project</li>
- <li>Type <span class="inline-code">make html</span></li>
- <li>The documents are in <span class="inline-code">_build/html</span></li>
- </ul>
- An example of the commands on Ubuntu follow:
- <div class="code">
-sudo apt install python3 python3-sphinx
-pip3 install sphinx_rtd_theme
-git clone https://github.com/apache/incubator-age
-cd incubator-age/doc
-make html
- </div>
+ The documentation is maintained at <a href ="https://github.com/apache/incubator-age-website">https://github.com/apache/incubator-age-website</a>. It includes <a href="https://github.com/apache/incubator-age-website#readme">more information</a> on how the documentation workflow works.
</div>
</div>