added docs with main commands (repo & entries)

mlcommons · Aug 31, 2020 · bfa5a2b · bfa5a2b
1 parent f8164df
commit bfa5a2b
Show file tree

Hide file tree

Showing 8 changed files with 1,459 additions and 1,036 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -16,4 +16,5 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
+	sphinx-apidoc -H "Autogenerated CK Python API" -f -T -o package ../ck
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/index.rst b/docs/index.rst
@@ -37,24 +37,23 @@ and ACM: https://cKnowledge.org/partners.
 
    src/installation
    src/first-steps
+   src/typical-usage
 
 .. toctree::
    :maxdepth: 2
-   :caption: User Guide
+   :caption: User guide
 
    src/commands
    src/specs
    src/how-to-contribute
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Tutorials
-
 .. toctree::
    :maxdepth: 2
    :caption: Resources
 
    _package/ck
+   src/misc
+
 
 Index
 =====