diff --git a/CHANGELOG.rst b/CHANGELOG.md similarity index 100% rename from CHANGELOG.rst rename to CHANGELOG.md diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index b6919b5..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = python -msphinx -SPHINXPROJ = pydu -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) \ No newline at end of file diff --git a/docs/README b/docs/README deleted file mode 100644 index 8ceb5f2..0000000 --- a/docs/README +++ /dev/null @@ -1,15 +0,0 @@ -About -===== - -This directory contains the reStructuredText (reST) sources to the psutil -documentation. You don't need to build them yourself, prebuilt versions are -available at http://psutil.readthedocs.io. -In case you want, you need to install sphinx first: - - $ pip install sphinx - -Then run: - - $ make html - -You'll then have an HTML version of the doc at _build/html/index.html. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..4cb2371 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,16 @@ +## pydu + +> pydu(python data structures and utils) is a library of useful data structures and utils +for Python 2 and 3, which collected from open source projects and created by contributors. + + +## Installation +To install pydu, simply: + +.. code-block:: bash + + $ pip install pydu + + +## Document +Fantastic documentation is available at: `English `_ | `中文版 `_. diff --git a/docs/_sidebar.md b/docs/_sidebar.md new file mode 100644 index 0000000..8c1aebe --- /dev/null +++ b/docs/_sidebar.md @@ -0,0 +1,28 @@ +* Modules + + * [Archive](archive.md) + * [Commad](cmd.md) + * [Compat](compat.md) + * [Console](console.md) + * [Convert](convert.md) + * [Dict](dict.md) + * [Date and Time](dt.md) + * [Environment](environ.md) + * [Exception](exception.md) + * [Functional](functional.md) + * [Inspect](inspect.md) + * [Iter](iter.md) + * [List](list.md) + * [Miscellanea](misc.md) + * [Network](network.md) + * [Path](path.md) + * [Platform](platform.md) + * [Process](process.md) + * [Request](request.md) + * [Set](set.md) + * [Slot](slot.md) + * [String](string.md) + * [System](system.md) + * [Unit](unit.md) + +* [Changelog](../changelog.md) diff --git a/docs/archive.rst b/docs/archive.md similarity index 100% rename from docs/archive.rst rename to docs/archive.md diff --git a/docs/cmd.rst b/docs/cmd.md similarity index 100% rename from docs/cmd.rst rename to docs/cmd.md diff --git a/docs/compat.rst b/docs/compat.md similarity index 100% rename from docs/compat.rst rename to docs/compat.md diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index c1cc8d8..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,172 +0,0 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- -# -# pydu documentation build configuration file, created by -# sphinx-quickstart on Tue Oct 31 23:34:51 2017. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -# 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('.')) - - -# -- 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 = ['sphinx.ext.viewcode'] - -# 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' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = 'pydu' -copyright = '2017, Prodesire' -author = 'Prodesire' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '' -# The full version, including alpha/beta/rc tags. -release = '' - -# 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 - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This patterns also effect to 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 = 'sphinx' - -# If true, `to do` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - - -# -- 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' - -# 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 = [] - -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# This is required for the alabaster theme -# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars -html_sidebars = { - '**': [ - 'about.html', - 'navigation.html', - 'relations.html', # needs 'show_related': True theme option to display - 'searchbox.html', - 'donate.html', - ] -} - - -# -- Options for HTMLHelp output ------------------------------------------ - -# Output file base name for HTML help builder. -htmlhelp_basename = 'pydu-doc' - - -# -- 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, 'pydu.tex', 'pydu Documentation', - 'Prodesire', '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, 'pydu', 'pydu 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, 'pydu', 'pydu Documentation', - author, 'pydu', 'One line description of project.', - 'Miscellaneous'), -] - - - diff --git a/docs/console.rst b/docs/console.md similarity index 100% rename from docs/console.rst rename to docs/console.md diff --git a/docs/convert.rst b/docs/convert.md similarity index 100% rename from docs/convert.rst rename to docs/convert.md diff --git a/docs/dict.rst b/docs/dict.md similarity index 100% rename from docs/dict.rst rename to docs/dict.md diff --git a/docs/dt.rst b/docs/dt.md similarity index 100% rename from docs/dt.rst rename to docs/dt.md diff --git a/docs/environ.rst b/docs/environ.md similarity index 100% rename from docs/environ.rst rename to docs/environ.md diff --git a/docs/exception.rst b/docs/exception.md similarity index 100% rename from docs/exception.rst rename to docs/exception.md diff --git a/docs/functional.rst b/docs/functional.md similarity index 100% rename from docs/functional.rst rename to docs/functional.md diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..8a041f7 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,22 @@ + + + + + Document + + + + + + +
Loading ...
+ + + + diff --git a/docs/index.rst b/docs/index.md similarity index 100% rename from docs/index.rst rename to docs/index.md diff --git a/docs/inspect.rst b/docs/inspect.md similarity index 100% rename from docs/inspect.rst rename to docs/inspect.md diff --git a/docs/iter.rst b/docs/iter.md similarity index 100% rename from docs/iter.rst rename to docs/iter.md diff --git a/docs/list.rst b/docs/list.md similarity index 100% rename from docs/list.rst rename to docs/list.md diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index b4b188f..0000000 --- a/docs/make.bat +++ /dev/null @@ -1,36 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=python -msphinx -) -set SOURCEDIR=. -set BUILDDIR=_build -set SPHINXPROJ=pydu - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The Sphinx module was not found. Make sure you have Sphinx installed, - echo.then set the SPHINXBUILD environment variable to point to the full - echo.path of the 'sphinx-build' executable. Alternatively you may add the - echo.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% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% - -:end -popd diff --git a/docs/misc.rst b/docs/misc.md similarity index 100% rename from docs/misc.rst rename to docs/misc.md diff --git a/docs/network.rst b/docs/network.md similarity index 100% rename from docs/network.rst rename to docs/network.md diff --git a/docs/path.rst b/docs/path.md similarity index 100% rename from docs/path.rst rename to docs/path.md diff --git a/docs/platform.rst b/docs/platform.md similarity index 100% rename from docs/platform.rst rename to docs/platform.md diff --git a/docs/process.rst b/docs/process.md similarity index 100% rename from docs/process.rst rename to docs/process.md diff --git a/docs/request.rst b/docs/request.md similarity index 100% rename from docs/request.rst rename to docs/request.md diff --git a/docs/set.rst b/docs/set.md similarity index 100% rename from docs/set.rst rename to docs/set.md diff --git a/docs/slot.rst b/docs/slot.md similarity index 100% rename from docs/slot.rst rename to docs/slot.md diff --git a/docs/string.rst b/docs/string.md similarity index 100% rename from docs/string.rst rename to docs/string.md diff --git a/docs/system.rst b/docs/system.md similarity index 100% rename from docs/system.rst rename to docs/system.md diff --git a/docs/unit.rst b/docs/unit.md similarity index 100% rename from docs/unit.rst rename to docs/unit.md