diff --git a/.gitignore b/.gitignore index f971876f..914bcccd 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ # Logs logs *.log +*_build +*_static +*_templates +.idea diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..d4bb2cbb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..77437b87 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,61 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- 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('.')) +import sphinx_rtd_theme + + +# -- Project information ----------------------------------------------------- + +project = 'MyEMS' +copyright = '2020, MyEMS' +author = 'MyEMS' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx_rtd_theme", +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# 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'] + + +# -- 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 = "sphinx_rtd_theme" + +# 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'] + +master_doc = 'index' + +# Recommended configuration for i18n. +# https://www.sphinx-doc.org/en/master/usage/advanced/intl.html +locale_dirs = ['locale/'] +gettext_compact = False diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..117104bf --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,22 @@ +.. MyEMS documentation master file, created by + sphinx-quickstart on Mon Nov 23 13:02:40 2020. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to MyEMS's documentation! +================================= +.. meta:: + :description lang=en: MyEMS is an industry leading open source energy management system. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/locale/de/LC_MESSAGES/index.po b/docs/locale/de/LC_MESSAGES/index.po new file mode 100644 index 00000000..edb9f46e --- /dev/null +++ b/docs/locale/de/LC_MESSAGES/index.po @@ -0,0 +1,46 @@ +# Translations template for PROJECT. +# Copyright (C) 2020 ORGANIZATION +# This file is distributed under the same license as the PROJECT project. +# FIRST AUTHOR , 2020. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: PROJECT VERSION\n" +"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" +"POT-Creation-Date: 2020-11-24 16:58+0800\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.9.0\n" + +#: ../../index.rst:11 +msgid "Contents:" +msgstr "Inhalt:" + +#: ../../index.rst:7 +msgid "Welcome to MyEMS's documentation!" +msgstr "Willkommen in der Dokumentation von MyEMS!" + +#: ../../index.rst:8 +msgid "MyEMS ist ein branchenführendes Open-Source-Energiemanagementsystem." +msgstr "MyEMS is an industry leading open source energy management system." + +#: ../../index.rst:18 +msgid "Indices and tables" +msgstr "Indizes und Tabellen" + +#: ../../index.rst:20 +msgid ":ref:`genindex`" +msgstr ":ref:`genindex`" + +#: ../../index.rst:21 +msgid ":ref:`modindex`" +msgstr ":ref:`modindex`" + +#: ../../index.rst:22 +msgid ":ref:`search`" +msgstr ":ref:`search`" diff --git a/docs/locale/zh_CN/LC_MESSAGES/index.po b/docs/locale/zh_CN/LC_MESSAGES/index.po new file mode 100644 index 00000000..89081845 --- /dev/null +++ b/docs/locale/zh_CN/LC_MESSAGES/index.po @@ -0,0 +1,46 @@ +# Translations template for PROJECT. +# Copyright (C) 2020 ORGANIZATION +# This file is distributed under the same license as the PROJECT project. +# FIRST AUTHOR , 2020. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: PROJECT VERSION\n" +"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" +"POT-Creation-Date: 2020-11-24 16:58+0800\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.9.0\n" + +#: ../../index.rst:11 +msgid "Contents:" +msgstr "" + +#: ../../index.rst:7 +msgid "Welcome to MyEMS's documentation!" +msgstr "欢迎使用MyEMS文档!" + +#: ../../index.rst:8 +msgid "MyEMS is an industry leading open source energy management system." +msgstr "MyEMS是行业领先的开源能源管理系统。" + +#: ../../index.rst:18 +msgid "Indices and tables" +msgstr "索引和表格" + +#: ../../index.rst:20 +msgid ":ref:`genindex`" +msgstr ":ref:`genindex`" + +#: ../../index.rst:21 +msgid ":ref:`modindex`" +msgstr ":ref:`modindex`" + +#: ../../index.rst:22 +msgid ":ref:`search`" +msgstr ":ref:`search`" diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..2119f510 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd