merge devel into master

Author: Han Wang

.github/workflows/mirror_gitee.yml

@@ -0,0 +1,19 @@
+name: Mirror to Gitee Repo
+
+on: [ push, delete, create ]
+
+# Ensures that only one mirror task will run at a time.
+concurrency:
+  group: git-mirror
+
+jobs:
+  git-mirror:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: wearerequired/git-mirror-action@v1
+        env:
+          ORGANIZATION: deepmodeling
+          SSH_PRIVATE_KEY: ${{ secrets.SYNC_GITEE_PRIVATE_KEY }}
+        with:
+          source-repo: "git@github.com:deepmodeling/dpgen.git"
+          destination-repo: "git@gitee.com:deepmodeling/dpgen.git"

.gitignore

@@ -39,3 +39,4 @@ dpgen.egg-info
 dbconfig.json
 .vscode/*
 .idea/*
+_build

README.md

@@ -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)

doc/Makefile

@@ -0,0 +1,4 @@
+# How to contribute
+
+- If you want to add the documentation of a toy model, simply put your file in the directory doc/toymodels/ and push;
+- If you want to add a new directory for a new category of instructions, make a new directory and add it in doc/index.rst.

doc/README.md

@@ -0,0 +1,80 @@
+# 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 subprocess
+# import sys
+import recommonmark
+from recommonmark.transform import AutoStructify
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'DPGEN'
+copyright = '2020, Deep Potential'
+author = 'Deep Potential'
+
+
+# -- 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 = [
+#     'recommonmark',
+#     "sphinx_rtd_theme",
+#     'myst_parser',
+#     'sphinx_markdown_tables',
+#     'sphinx.ext.autosummary'
+# ]
+
+extensions = [
+    "sphinx_rtd_theme",
+    'myst_parser',
+    'sphinx.ext.autosummary',
+]
+
+
+# Tell sphinx what the primary language being documented is.
+primary_domain = 'cpp'
+
+# Tell sphinx what the pygments highlight language should be.
+highlight_language = 'cpp'
+
+# 
+myst_heading_anchors = 4
+
+# 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']
+# html_css_files = ['css/custom.css']
+
+autodoc_default_flags = ['members']
+autosummary_generate = True
+master_doc = 'index'

doc/conf.py

@@ -0,0 +1,28 @@
+==========================
+DPGEN's documentation
+==========================
+
+.. _tutorial:
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Tutorial
+   :glob:  
+
+   toymodels/*
+
+
+.. _Contribution:
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contribution Guild
+
+   README.md
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+.. _feedback: 
+.. _affiliated packages: 

doc/index.rst

@@ -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

doc/make.bat

@@ -0,0 +1,5 @@
+sphinx==3.2.1
+recommonmark==0.7.1
+sphinx_rtd_theme==0.5.2
+sphinx_markdown_tables==0.0.15
+myst-parser==0.13.7

doc/requirements.txt

@@ -0,0 +1 @@
+# This is a blank file to test sphinx-build