summaryrefslogtreecommitdiff
path: root/tests/roots/test-basic
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2016-07-14 09:41:46 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2016-07-14 09:41:46 +0900
commit47b33e93e5ad4b226f124cd21a5e5da535b930b2 (patch)
treee880ef82d9ede385e554e4263592c3999e7dacee /tests/roots/test-basic
parentb035094067dad511bece75b495aab0aa9d9a273c (diff)
downloadsphinx-git-47b33e93e5ad4b226f124cd21a5e5da535b930b2.tar.gz
Optimize tests: test_applehelp_output
Diffstat (limited to 'tests/roots/test-basic')
-rw-r--r--tests/roots/test-basic/conf.py7
-rw-r--r--tests/roots/test-basic/index.rst29
2 files changed, 36 insertions, 0 deletions
diff --git a/tests/roots/test-basic/conf.py b/tests/roots/test-basic/conf.py
new file mode 100644
index 000000000..31e7a6ed4
--- /dev/null
+++ b/tests/roots/test-basic/conf.py
@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+
+master_doc = 'index'
+
+latex_documents = [
+ (master_doc, 'test.tex', 'The basic Sphinx documentation for testing', 'Sphinx', 'report')
+]
diff --git a/tests/roots/test-basic/index.rst b/tests/roots/test-basic/index.rst
new file mode 100644
index 000000000..8c4ca7d80
--- /dev/null
+++ b/tests/roots/test-basic/index.rst
@@ -0,0 +1,29 @@
+The basic Sphinx documentation for testing
+==========================================
+
+Sphinx is a tool that makes it easy to create intelligent and beautiful
+documentation for Python projects (or other documents consisting of multiple
+reStructuredText sources), written by Georg Brandl. It was originally created
+for the new Python documentation, and has excellent facilities for Python
+project documentation, but C/C++ is supported as well, and more languages are
+planned.
+
+Sphinx uses reStructuredText as its markup language, and many of its strengths
+come from the power and straightforwardness of reStructuredText and its parsing
+and translating suite, the Docutils.
+
+Among its features are the following:
+
+* Output formats: HTML (including derivative formats such as HTML Help, Epub
+ and Qt Help), plain text, manual pages and LaTeX or direct PDF output
+ using rst2pdf
+* Extensive cross-references: semantic markup and automatic links
+ for functions, classes, glossary terms and similar pieces of information
+* Hierarchical structure: easy definition of a document tree, with automatic
+ links to siblings, parents and children
+* Automatic indices: general index as well as a module index
+* Code handling: automatic highlighting using the Pygments highlighter
+* Flexible HTML output using the Jinja 2 templating engine
+* Various extensions are available, e.g. for automatic testing of snippets
+ and inclusion of appropriately formatted docstrings
+* Setuptools integration