Skip to content

Commit acd0726

Browse files
marmarekmarmarek
committed
Replace _doc submodule with redirects to rtd site
1 parent 155ad99 commit acd0726

File tree

236 files changed

+3565
-4
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

236 files changed

+3565
-4
lines changed

‎.gitmodules‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
[submodule "_posts"]
55
path = _posts
66
url = https://github.com/QubesOS/qubes-posts
7-
[submodule "_doc"]
8-
path = _doc
9-
url = https://github.com/QubesOS/qubes-doc
107
[submodule "_hcl"]
118
path = _hcl
129
url = https://github.com/QubesOS/qubes-hcl

‎_doc‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎_doc/_dev/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_build

‎_doc/_dev/Makefile‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
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 https://www.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 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 " devhelp to make HTML files and a Devhelp project"
34+
@echo " epub to make an epub"
35+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
37+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
38+
@echo " text to make text files"
39+
@echo " man to make manual pages"
40+
@echo " texinfo to make Texinfo files"
41+
@echo " info to make Texinfo files and run them through makeinfo"
42+
@echo " gettext to make PO message catalogs"
43+
@echo " changes to make an overview of all changed/added/deprecated items"
44+
@echo " xml to make Docutils-native XML files"
45+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
46+
@echo " linkcheck to check all external links for integrity"
47+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
48+
49+
clean:
50+
rm -rf $(BUILDDIR)/*
51+
52+
html:
53+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
54+
@echo
55+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
56+
57+
dirhtml:
58+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
59+
@echo
60+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
61+
62+
singlehtml:
63+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
64+
@echo
65+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
66+
67+
pickle:
68+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
69+
@echo
70+
@echo "Build finished; now you can process the pickle files."
71+
72+
json:
73+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
74+
@echo
75+
@echo "Build finished; now you can process the JSON files."
76+
77+
htmlhelp:
78+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
79+
@echo
80+
@echo "Build finished; now you can run HTML Help Workshop with the" \
81+
".hhp project file in $(BUILDDIR)/htmlhelp."
82+
83+
qthelp:
84+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
85+
@echo
86+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
87+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
88+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/QubesOSDeveloper.qhcp"
89+
@echo "To view the help file:"
90+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/QubesOSDeveloper.qhc"
91+
92+
devhelp:
93+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
94+
@echo
95+
@echo "Build finished."
96+
@echo "To view the help file:"
97+
@echo "# mkdir -p $$HOME/.local/share/devhelp/QubesOSDeveloper"
98+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/QubesOSDeveloper"
99+
@echo "# devhelp"
100+
101+
epub:
102+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
103+
@echo
104+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
105+
106+
latex:
107+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
108+
@echo
109+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
110+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
111+
"(use \`make latexpdf' here to do that automatically)."
112+
113+
latexpdf:
114+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
115+
@echo "Running LaTeX files through pdflatex..."
116+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
117+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
118+
119+
latexpdfja:
120+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
121+
@echo "Running LaTeX files through platex and dvipdfmx..."
122+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
123+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
124+
125+
text:
126+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
127+
@echo
128+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
129+
130+
man:
131+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
132+
@echo
133+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
134+
135+
texinfo:
136+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
137+
@echo
138+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
139+
@echo "Run \`make' in that directory to run these through makeinfo" \
140+
"(use \`make info' here to do that automatically)."
141+
142+
info:
143+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
144+
@echo "Running Texinfo files through makeinfo..."
145+
make -C $(BUILDDIR)/texinfo info
146+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
147+
148+
gettext:
149+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
150+
@echo
151+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
152+
153+
changes:
154+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
155+
@echo
156+
@echo "The overview file is in $(BUILDDIR)/changes."
157+
158+
linkcheck:
159+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
160+
@echo
161+
@echo "Link check complete; look for any errors in the above output " \
162+
"or in $(BUILDDIR)/linkcheck/output.txt."
163+
164+
doctest:
165+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
166+
@echo "Testing of doctests in the sources finished, look at the " \
167+
"results in $(BUILDDIR)/doctest/output.txt."
168+
169+
xml:
170+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
171+
@echo
172+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
173+
174+
pseudoxml:
175+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
176+
@echo
177+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

‎_doc/_dev/_static/.gitignore‎

Whitespace-only changes.

‎_doc/_dev/_templates/.gitignore‎

Whitespace-only changes.

‎_doc/_dev/conf.py‎

Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
#!/usr/bin/env python3
2+
# -*- coding: utf-8 -*-
3+
#
4+
# Qubes OS developer's documentation build configuration file, created by
5+
# sphinx-quickstart on Tue May 30 16:30:03 2017.
6+
#
7+
# This file is execfile()d with the current directory set to its
8+
# containing dir.
9+
#
10+
# Note that not all possible configuration values are present in this
11+
# autogenerated file.
12+
#
13+
# All configuration values have a default; values that are commented out
14+
# serve to show the default.
15+
16+
import os
17+
import sys
18+
import datetime
19+
20+
# If extensions (or modules to document with autodoc) are in another directory,
21+
# add these directories to sys.path here. If the directory is relative to the
22+
# documentation root, use os.path.abspath to make it absolute, like shown here.
23+
#sys.path.insert(0, os.path.abspath('.'))
24+
25+
# -- General configuration ------------------------------------------------
26+
27+
# If your documentation needs a minimal Sphinx version, state it here.
28+
#needs_sphinx = '1.0'
29+
30+
# Add any Sphinx extension module names here, as strings. They can be
31+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32+
# ones.
33+
extensions = [
34+
'sphinx.ext.intersphinx',
35+
'sphinx.ext.todo',
36+
]
37+
38+
# Add any paths that contain templates here, relative to this directory.
39+
templates_path = ['_templates']
40+
41+
# The suffix of source filenames.
42+
source_suffix = '.rst'
43+
44+
# The encoding of source files.
45+
#source_encoding = 'utf-8-sig'
46+
47+
# The master toctree document.
48+
master_doc = 'index'
49+
50+
# General information about the project.
51+
project = 'Qubes OS'
52+
copyright = '2010-{:%Y}, Invisible Things Lab'.format(datetime.date.today())
53+
54+
# The version info for the project you're documenting, acts as replacement for
55+
# |version| and |release|, also used in various other places throughout the
56+
# built documents.
57+
#
58+
# The short X.Y version.
59+
version = 'R4'
60+
# The full version, including alpha/beta/rc tags.
61+
release = 'R4.0'
62+
63+
# The language for content autogenerated by Sphinx. Refer to documentation
64+
# for a list of supported languages.
65+
#language = None
66+
67+
# There are two options for replacing |today|: either, you set today to some
68+
# non-false value, then it is used:
69+
#today = ''
70+
# Else, today_fmt is used as the format for a strftime call.
71+
today_fmt = '%Y-%m-%d'
72+
73+
# List of patterns, relative to source directory, that match files and
74+
# directories to ignore when looking for source files.
75+
exclude_patterns = ['_build']
76+
77+
# The reST default role (used for this markup: `text`) to use for all
78+
# documents.
79+
#default_role = None
80+
81+
# If true, '()' will be appended to :func: etc. cross-reference text.
82+
#add_function_parentheses = True
83+
84+
# If true, the current module name will be prepended to all description
85+
# unit titles (such as .. function::).
86+
#add_module_names = True
87+
88+
# If true, sectionauthor and moduleauthor directives will be shown in the
89+
# output. They are ignored by default.
90+
#show_authors = False
91+
92+
# The name of the Pygments (syntax highlighting) style to use.
93+
pygments_style = 'sphinx'
94+
95+
# A list of ignored prefixes for module index sorting.
96+
#modindex_common_prefix = []
97+
98+
# If true, keep warnings as "system message" paragraphs in the built documents.
99+
#keep_warnings = False
100+
101+
102+
# -- Options for HTML output ----------------------------------------------
103+
104+
# The theme to use for HTML and HTML Help pages. See the documentation for
105+
# a list of builtin themes.
106+
html_theme = 'nature'
107+
108+
# Theme options are theme-specific and customize the look and feel of a theme
109+
# further. For a list of options available for each theme, see the
110+
# documentation.
111+
#html_theme_options = {}
112+
113+
# Add any paths that contain custom themes here, relative to this directory.
114+
#html_theme_path = []
115+
116+
# The name for this set of Sphinx documents. If None, it defaults to
117+
# "<project> v<release> documentation".
118+
#html_title = None
119+
120+
# A shorter title for the navigation bar. Default is the same as html_title.
121+
#html_short_title = None
122+
123+
# The name of an image file (relative to this directory) to place at the top
124+
# of the sidebar.
125+
#html_logo = None
126+
127+
# The name of an image file (within the static path) to use as favicon of the
128+
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
129+
# pixels large.
130+
#html_favicon = None
131+
132+
# Add any paths that contain custom static files (such as style sheets) here,
133+
# relative to this directory. They are copied after the builtin static files,
134+
# so a file named "default.css" will overwrite the builtin "default.css".
135+
html_static_path = ['_static']
136+
137+
# Add any extra paths that contain custom files (such as robots.txt or
138+
# .htaccess) here, relative to this directory. These files are copied
139+
# directly to the root of the documentation.
140+
#html_extra_path = []
141+
142+
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
143+
# using the given strftime format.
144+
#html_last_updated_fmt = '%b %d, %Y'
145+
146+
# If true, SmartyPants will be used to convert quotes and dashes to
147+
# typographically correct entities.
148+
#html_use_smartypants = True
149+
150+
# Custom sidebar templates, maps document names to template names.
151+
#html_sidebars = {}
152+
153+
# Additional templates that should be rendered to pages, maps page names to
154+
# template names.
155+
#html_additional_pages = {}
156+
157+
# If false, no module index is generated.
158+
#html_domain_indices = True
159+
160+
# If false, no index is generated.
161+
#html_use_index = True
162+
163+
# If true, the index is split into individual pages for each letter.
164+
#html_split_index = False
165+
166+
# If true, links to the reST sources are added to the pages.
167+
#html_show_sourcelink = True
168+
169+
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
170+
#html_show_sphinx = True
171+
172+
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
173+
#html_show_copyright = True
174+
175+
# If true, an OpenSearch description file will be output, and all pages will
176+
# contain a <link> tag referring to it. The value of this option must be the
177+
# base URL from which the finished HTML is served.
178+
#html_use_opensearch = ''
179+
180+
# This is the file name suffix for HTML files (e.g. ".xhtml").
181+
#html_file_suffix = None
182+
183+
# Output file base name for HTML help builder.
184+
htmlhelp_basename = 'QubesOSdev'
185+
186+
187+
# Example configuration for intersphinx: refer to the Python standard library.
188+
intersphinx_mapping = {
189+
'python': ('https://docs.python.org/', None),
190+
# 'core-admin': ('https://dev.qubes-os.org/projects/core-admin/en/latest/', None),
191+
}
192+
193+
# vim: ts=4 sts=4 sw=4 et

‎_doc/_dev/index.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Welcome to Qubes OS developer's documentation!
2+
==============================================
3+
4+
This is documentation for the source code. Please choose specific repostitory:
5+
6+
* `core-admin </projects/core-admin>`_
7+
* `core-admin-client </projects/core-admin-client>`_
8+
9+
Or see `the main Qubes OS documentation <https://www.qubes-os.org/doc/>`_.

0 commit comments

Comments
 (0)