From f826d77750d80a4413e5c5b62c2f9ece01f9e568 Mon Sep 17 00:00:00 2001 From: nanoric Date: Wed, 13 Feb 2019 01:49:44 -0400 Subject: [PATCH] [Add] add sphinx files into docs/ --- docs/.gitignore | 1 + docs/conf.py | 180 ++++++++++++++++++ docs/{introduction.md => index.md} | 0 docs/introduction_en.md | 1 - docs/locale/en/LC_MESSAGES/introduction.po | 23 +++ docs/locale/introduction.pot | 22 +++ docs/locale/zh-CN/LC_MESSAGES/introduction.po | 23 +++ docs/translation-update.sh | 4 + 8 files changed, 253 insertions(+), 1 deletion(-) create mode 100644 docs/.gitignore create mode 100644 docs/conf.py rename docs/{introduction.md => index.md} (100%) delete mode 100644 docs/introduction_en.md create mode 100644 docs/locale/en/LC_MESSAGES/introduction.po create mode 100644 docs/locale/introduction.pot create mode 100644 docs/locale/zh-CN/LC_MESSAGES/introduction.po create mode 100644 docs/translation-update.sh diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..7dd8f770 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +.doctrees \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..40ed53f2 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,180 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'vnpy' +copyright = '2019, vn.py Team' +author = 'vn.py Team' + +# The short X.Y version +version = '2.0' +# The full version, including alpha/beta/rc tags +release = '2.0-DEV' + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'recommonmark' +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +# source_suffix = '.rst' +source_suffix = { + '.rst': 'restructuredtext', + '.txt': 'markdown', + '.md': 'markdown', +} + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None +locale_dirs = ["locale/"] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'vnpydoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'vnpy.tex', 'vnpy Documentation', + 'vn.py Team', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'vnpy', 'vnpy Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'vnpy', 'vnpy Documentation', + author, 'vnpy', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] diff --git a/docs/introduction.md b/docs/index.md similarity index 100% rename from docs/introduction.md rename to docs/index.md diff --git a/docs/introduction_en.md b/docs/introduction_en.md deleted file mode 100644 index 7882ffb6..00000000 --- a/docs/introduction_en.md +++ /dev/null @@ -1 +0,0 @@ -vn.py Documentation diff --git a/docs/locale/en/LC_MESSAGES/introduction.po b/docs/locale/en/LC_MESSAGES/introduction.po new file mode 100644 index 00000000..be28769d --- /dev/null +++ b/docs/locale/en/LC_MESSAGES/introduction.po @@ -0,0 +1,23 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2019, vn.py Team +# This file is distributed under the same license as the vnpy package. +# FIRST AUTHOR , 2019. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: vnpy 2.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2019-02-13 01:17-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.6.0\n" + +#: ../introduction.md:1 +msgid "vn.py文档" +msgstr "" + diff --git a/docs/locale/introduction.pot b/docs/locale/introduction.pot new file mode 100644 index 00000000..d51b56a1 --- /dev/null +++ b/docs/locale/introduction.pot @@ -0,0 +1,22 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2019, vn.py Team +# This file is distributed under the same license as the vnpy package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: vnpy 2.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2019-02-13 01:17-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: ../introduction.md:1 +msgid "vn.py文档" +msgstr "" + diff --git a/docs/locale/zh-CN/LC_MESSAGES/introduction.po b/docs/locale/zh-CN/LC_MESSAGES/introduction.po new file mode 100644 index 00000000..be28769d --- /dev/null +++ b/docs/locale/zh-CN/LC_MESSAGES/introduction.po @@ -0,0 +1,23 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2019, vn.py Team +# This file is distributed under the same license as the vnpy package. +# FIRST AUTHOR , 2019. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: vnpy 2.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2019-02-13 01:17-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.6.0\n" + +#: ../introduction.md:1 +msgid "vn.py文档" +msgstr "" + diff --git a/docs/translation-update.sh b/docs/translation-update.sh new file mode 100644 index 00000000..f7ef5ce5 --- /dev/null +++ b/docs/translation-update.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env bash + +sphinx-build -b gettext . locale +sphinx-intl update -p locale -l zh-CN -l en \ No newline at end of file