Skip to content
Permalink
Browse files

Add firstinstall to docs

  • Loading branch information...
vanosg committed Oct 24, 2019
1 parent 0cca6ac commit c7501d802408272dab777ba91af81eda5262ee1c
Showing with 15,935 additions and 4 deletions.
  1. +2 −1 doc/sphinx_source/Makefile
  2. +3 −3 doc/sphinx_source/_themes/agogo/theme.conf
  3. +177 −0 doc/sphinx_source/firstinstall/Makefile
  4. BIN doc/sphinx_source/firstinstall/_build/doctrees/environment.pickle
  5. BIN doc/sphinx_source/firstinstall/_build/doctrees/firstinstall.doctree
  6. BIN doc/sphinx_source/firstinstall/_build/doctrees/index.doctree
  7. +4 −0 doc/sphinx_source/firstinstall/_build/html/.buildinfo
  8. +196 −0 doc/sphinx_source/firstinstall/_build/html/_sources/firstinstall.rst.txt
  9. +13 −0 doc/sphinx_source/firstinstall/_build/html/_sources/index.rst.txt
  10. +532 −0 doc/sphinx_source/firstinstall/_build/html/_static/agogo.css
  11. BIN doc/sphinx_source/firstinstall/_build/html/_static/ajax-loader.gif
  12. +676 −0 doc/sphinx_source/firstinstall/_build/html/_static/basic.css
  13. BIN doc/sphinx_source/firstinstall/_build/html/_static/bgfooter.png
  14. BIN doc/sphinx_source/firstinstall/_build/html/_static/bgtop.png
  15. BIN doc/sphinx_source/firstinstall/_build/html/_static/comment-bright.png
  16. BIN doc/sphinx_source/firstinstall/_build/html/_static/comment-close.png
  17. BIN doc/sphinx_source/firstinstall/_build/html/_static/comment.png
  18. +315 −0 doc/sphinx_source/firstinstall/_build/html/_static/doctools.js
  19. +10 −0 doc/sphinx_source/firstinstall/_build/html/_static/documentation_options.js
  20. BIN doc/sphinx_source/firstinstall/_build/html/_static/down-pressed.png
  21. BIN doc/sphinx_source/firstinstall/_build/html/_static/down.png
  22. +40 −0 doc/sphinx_source/firstinstall/_build/html/_static/eggdrop.css
  23. BIN doc/sphinx_source/firstinstall/_build/html/_static/eggman.png.gif
  24. BIN doc/sphinx_source/firstinstall/_build/html/_static/file.png
  25. +10,253 −0 doc/sphinx_source/firstinstall/_build/html/_static/jquery-3.2.1.js
  26. +4 −0 doc/sphinx_source/firstinstall/_build/html/_static/jquery.js
  27. +297 −0 doc/sphinx_source/firstinstall/_build/html/_static/language_data.js
  28. BIN doc/sphinx_source/firstinstall/_build/html/_static/minus.png
  29. BIN doc/sphinx_source/firstinstall/_build/html/_static/plus.png
  30. +69 −0 doc/sphinx_source/firstinstall/_build/html/_static/pygments.css
  31. +481 −0 doc/sphinx_source/firstinstall/_build/html/_static/searchtools.js
  32. +999 −0 doc/sphinx_source/firstinstall/_build/html/_static/underscore-1.3.1.js
  33. +31 −0 doc/sphinx_source/firstinstall/_build/html/_static/underscore.js
  34. BIN doc/sphinx_source/firstinstall/_build/html/_static/up-pressed.png
  35. BIN doc/sphinx_source/firstinstall/_build/html/_static/up.png
  36. +808 −0 doc/sphinx_source/firstinstall/_build/html/_static/websupport.js
  37. +279 −0 doc/sphinx_source/firstinstall/_build/html/firstinstall.html
  38. +109 −0 doc/sphinx_source/firstinstall/_build/html/index.html
  39. +8 −0 doc/sphinx_source/firstinstall/_build/html/objects.inv
  40. +118 −0 doc/sphinx_source/firstinstall/_build/html/search.html
  41. +1 −0 doc/sphinx_source/firstinstall/_build/html/searchindex.js
  42. +40 −0 doc/sphinx_source/firstinstall/_static/eggdrop.css
  43. BIN doc/sphinx_source/firstinstall/_static/eggman.png.gif
  44. +1 −0 doc/sphinx_source/firstinstall/_themes
  45. +258 −0 doc/sphinx_source/firstinstall/conf.py
  46. +2 −0 doc/sphinx_source/firstinstall/docutils.conf
  47. +196 −0 doc/sphinx_source/firstinstall/firstinstall.rst
  48. +13 −0 doc/sphinx_source/firstinstall/index.rst
@@ -47,7 +47,8 @@ help:
@echo " doctest to run all doctests embedded in the documentation (if enabled)"

clean:
rm -rf $(BUILDDIR)/*
# rm -rf $(BUILDDIR)/*
@echo "Do not use this, remember what happened last time?"

html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@@ -6,10 +6,10 @@ pygments_style = tango
[options]
bodyfont = "Verdana", Arial, sans-serif
headerfont = "Georgia", "Times New Roman", serif
pagewidth = 70em
documentwidth = 50em
pagewidth = 90em
documentwidth = 65em
rightsidebar = false
sidebarwidth = 20em
sidebarwidth = 18em
bgcolor = #eeeeec
headerbg = url(bgtop.png) top left repeat-x
footerbg = url(bgfooter.png) top left repeat-x
@@ -0,0 +1,177 @@
# Makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build

# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(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/)
endif

# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext

help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"

clean:
rm -rf $(BUILDDIR)/*

html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."

json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."

htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."

qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Eggdrop.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Eggdrop.qhc"

devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/Eggdrop"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Eggdrop"
@echo "# devhelp"

epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."

latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."

man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."

info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."

gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."

linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."

doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."

pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: f05a89e4d1b6968be23f4524a4293e1c
tags: 645f666f9bcd5a90fca523b33c5a78b7

0 comments on commit c7501d8

Please sign in to comment.
You can’t perform that action at this time.