Skip to content
This repository was archived by the owner on Jan 15, 2024. It is now read-only.

Commit 7e1f9d0

Browse files
acphileacphile
authored
[DOC] Add the basic documentation for the embedding API (#1281)
This does not yet include the fully functional Makefile with the docs_local target so that the notebook compilation step can be executed.
1 parent 1f9ad44 commit 7e1f9d0

37 files changed

+4319
-17
lines changed

‎docs/.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
doxygen
2+
_build
3+
gen_modules
4+
tutorials
5+
doctrees

‎docs/.nojekyll‎

Whitespace-only changes.

‎docs/404.rst‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
:orphan:
2+
3+
Page Not Found
4+
--------------
5+
6+
You stumbled upon a page that's making us scratch our brains right now. Before any of us panics,
7+
we'd like you to know that you are being redirected to a better known and cozy place, in just a few seconds.
8+
9+
.. image:: _static/404.jpg
10+
:alt: Page Not Found
11+
:width: 60%
12+
:align: center
13+
:target: ./index.html
14+
15+
.. raw:: html
16+
17+
<script type="text/javascript">
18+
window.onload = function() {
19+
var seconds = 5;
20+
var url = "http://gluon-nlp.mxnet.io";
21+
setTimeout(function() {
22+
window.location.href = url;
23+
}, seconds*1000);
24+
};
25+
</script>

‎docs/Doxyfile‎

Lines changed: 2353 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/Makefile‎

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS = -j 4
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = _build
9+
10+
# User-friendly check for sphinx-build
11+
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12+
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13+
endif
14+
15+
# Internal variables.
16+
PAPEROPT_a4 = -D latex_paper_size=a4
17+
PAPEROPT_letter = -D latex_paper_size=letter
18+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
19+
# the i18n builder cannot share the environment and doctrees with the others
20+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
21+
22+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
23+
24+
help:
25+
@echo "Please use \`make <target>' where <target> is one of"
26+
@echo " html to make standalone HTML files"
27+
@echo " dirhtml to make HTML files named index.html in directories"
28+
@echo " singlehtml to make a single large HTML file"
29+
@echo " pickle to make pickle files"
30+
@echo " json to make JSON files"
31+
@echo " htmlhelp to make HTML files and a HTML help project"
32+
@echo " qthelp to make HTML files and a qthelp project"
33+
@echo " applehelp to make an Apple Help Book"
34+
@echo " devhelp to make HTML files and a Devhelp project"
35+
@echo " epub to make an epub"
36+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
37+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
38+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
39+
@echo " text to make text files"
40+
@echo " man to make manual pages"
41+
@echo " texinfo to make Texinfo files"
42+
@echo " info to make Texinfo files and run them through makeinfo"
43+
@echo " gettext to make PO message catalogs"
44+
@echo " changes to make an overview of all changed/added/deprecated items"
45+
@echo " xml to make Docutils-native XML files"
46+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
47+
@echo " linkcheck to check all external links for integrity"
48+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
49+
@echo " coverage to run coverage check of the documentation (if enabled)"
50+
51+
clean:
52+
rm -rf $(BUILDDIR)/*
53+
rm -rf gen_modules
54+
rm -rf html
55+
56+
html:
57+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
58+
@echo
59+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
60+
61+
dirhtml:
62+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
63+
@echo
64+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
65+
66+
singlehtml:
67+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
68+
@echo
69+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
70+
71+
pickle:
72+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
73+
@echo
74+
@echo "Build finished; now you can process the pickle files."
75+
76+
json:
77+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
78+
@echo
79+
@echo "Build finished; now you can process the JSON files."
80+
81+
htmlhelp:
82+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
83+
@echo
84+
@echo "Build finished; now you can run HTML Help Workshop with the" \
85+
".hhp project file in $(BUILDDIR)/htmlhelp."
86+
87+
qthelp:
88+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
89+
@echo
90+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
91+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
92+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/rabit.qhcp"
93+
@echo "To view the help file:"
94+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/rabit.qhc"
95+
96+
applehelp:
97+
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
98+
@echo
99+
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
100+
@echo "N.B. You won't be able to view it unless you put it in" \
101+
"~/Library/Documentation/Help or install it in your application" \
102+
"bundle."
103+
104+
devhelp:
105+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
106+
@echo
107+
@echo "Build finished."
108+
@echo "To view the help file:"
109+
@echo "# mkdir -p $$HOME/.local/share/devhelp/rabit"
110+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/rabit"
111+
@echo "# devhelp"
112+
113+
epub:
114+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
115+
@echo
116+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
117+
118+
latex:
119+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
120+
@echo
121+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
122+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
123+
"(use \`make latexpdf' here to do that automatically)."
124+
125+
latexpdf:
126+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
127+
@echo "Running LaTeX files through pdflatex..."
128+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
129+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
130+
131+
latexpdfja:
132+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
133+
@echo "Running LaTeX files through platex and dvipdfmx..."
134+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
135+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
136+
137+
text:
138+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
139+
@echo
140+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
141+
142+
man:
143+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
144+
@echo
145+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
146+
147+
texinfo:
148+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
149+
@echo
150+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
151+
@echo "Run \`make' in that directory to run these through makeinfo" \
152+
"(use \`make info' here to do that automatically)."
153+
154+
info:
155+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
156+
@echo "Running Texinfo files through makeinfo..."
157+
make -C $(BUILDDIR)/texinfo info
158+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
159+
160+
gettext:
161+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
162+
@echo
163+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
164+
165+
changes:
166+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
167+
@echo
168+
@echo "The overview file is in $(BUILDDIR)/changes."
169+
170+
linkcheck:
171+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
172+
@echo
173+
@echo "Link check complete; look for any errors in the above output " \
174+
"or in $(BUILDDIR)/linkcheck/output.txt."
175+
176+
doctest:
177+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
178+
@echo "Testing of doctests in the sources finished, look at the " \
179+
"results in $(BUILDDIR)/doctest/output.txt."
180+
181+
coverage:
182+
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
183+
@echo "Testing of coverage in the sources finished, look at the " \
184+
"results in $(BUILDDIR)/coverage/python.txt."
185+
186+
xml:
187+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
188+
@echo
189+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
190+
191+
pseudoxml:
192+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
193+
@echo
194+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

‎docs/README.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
The documentation of gluonnlp is generated with recommonmark and sphinx.
2+
3+
- pip install sphinx>=1.5.5 sphinx-gallery sphinx_rtd_theme matplotlib Image recommonmark

‎docs/_static/404.jpg‎

142 KB
Loading

‎docs/_static/custom.css‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.Logos {
2+
display: inline;
3+
margin: 1em;
4+
max-width: 120px;
5+
}
6+
7+
.install {
8+
max-width: 800px;
9+
}
10+
.install .title {
11+
display: inline-block;
12+
min-width: 100px;
13+
text-transform: uppercase;
14+
font-size: 90%;
15+
color: #555;
16+
}
17+
18+
.install .option {
19+
margin: 5px;
20+
}
21+
22+
@media (max-width: 650px) {
23+
.install .option, .install .title {
24+
width: 90%;
25+
}
26+
.install .title {
27+
margin-top: 1em;
28+
}

‎docs/_static/gluon-logo.svg‎

Lines changed: 37 additions & 0 deletions
Loading

‎docs/_static/gluon.ico‎

1.12 KB
Binary file not shown.

0 commit comments

Comments
 (0)