-
Notifications
You must be signed in to change notification settings - Fork 137
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Docs] Update REAME and setup Sphinx (#2)
* add video in README * add CITATION.cff * add mmhuman3d link * update video link * add badge * modify title size * add sphinx generated docs * add logo img in sphinx doc * Update video link in README * fix api.rst * fix sphinx build documentation * add additional license in index.rst * replace source code links in docs with github url * rm sphinx warn in cameras * update docstring * use github url in docs * revise acc to mmpose conf.py Co-authored-by: yanglei <yanglei@sensetime.com> Co-authored-by: Maoxie <edwardyzt@gmail.com>
- Loading branch information
3 people
authored
Dec 2, 2021
1 parent
25492c5
commit f107203
Showing
19 changed files
with
619 additions
and
130 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| cff-version: 1.2.0 | ||
| message: "If you use this software, please cite it as below." | ||
| authors: | ||
| - name: "MMHuman3D Contributors" | ||
| title: "MMHuman3D: OpenMMLab Human Pose and Shape Estimation Toolbox and Benchmark" | ||
| date-released: 2021-12-01 | ||
| url: "https://github.com/open-mmlab/mmhuman3d" | ||
| license: Apache-2.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| .header-logo { | ||
| background-image: url("../image/mmhuman3d-logo.png"); | ||
| background-size: 156px 40px; | ||
| height: 40px; | ||
| width: 156px; | ||
| } |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| mmhuman3d.apis | ||
| ---------------- | ||
| .. automodule:: mmhuman3d.apis | ||
| :members: | ||
|
|
||
| mmhuman3d.core | ||
| ---------------- | ||
|
|
||
| cameras | ||
| ^^^^^^^^^^ | ||
| .. automodule:: mmhuman3d.core.cameras | ||
| :members: | ||
|
|
||
| conventions | ||
| ^^^^^^^^^^^^^ | ||
| .. automodule:: mmhuman3d.core.conventions | ||
| :members: | ||
|
|
||
| evaluation | ||
| ^^^^^^^^^^ | ||
| .. automodule:: mmhuman3d.core.evaluation | ||
| :members: | ||
|
|
||
| filter | ||
| ^^^^^^^^^^ | ||
| .. automodule:: mmhuman3d.core.filter | ||
| :members: | ||
|
|
||
| optimizer | ||
| ^^^^^^^^^^ | ||
| .. automodule:: mmhuman3d.core.optimizer | ||
| :members: | ||
|
|
||
| parametric_model | ||
| ^^^^^^^^^^^^^^^^ | ||
| .. automodule:: mmhuman3d.core.parametric_model | ||
| :members: | ||
|
|
||
| visualization | ||
| ^^^^^^^^^^^^^ | ||
| .. automodule:: mmhuman3d.core.visualization | ||
| :members: | ||
|
|
||
| mmhuman3d.models | ||
| ---------------- | ||
|
|
||
| models | ||
| ^^^^^^ | ||
| .. automodule:: mmhuman3d.models | ||
| :members: | ||
|
|
||
| architectures | ||
| ^^^^^^^^^^^^^^ | ||
| .. automodule:: mmhuman3d.models.architectures | ||
| :members: | ||
|
|
||
| backbones | ||
| ^^^^^^^^^^ | ||
| .. automodule:: mmhuman3d.models.backbones | ||
| :members: | ||
|
|
||
| discriminators | ||
| ^^^^^^^^^^^^^^ | ||
| .. automodule:: mmhuman3d.models.discriminators | ||
| :members: | ||
|
|
||
| necks | ||
| ^^^^^^ | ||
| .. automodule:: mmhuman3d.models.necks | ||
| :members: | ||
|
|
||
| heads | ||
| ^^^^^^ | ||
| .. automodule:: mmhuman3d.models.heads | ||
| :members: | ||
|
|
||
| losses | ||
| ^^^^^^ | ||
| .. automodule:: mmhuman3d.models.losses | ||
| :members: | ||
|
|
||
| utils | ||
| ^^^^^^ | ||
| .. automodule:: mmhuman3d.models.utils | ||
| :members: | ||
|
|
||
| mmhuman3d.data | ||
| ----------------- | ||
|
|
||
| data | ||
| ^^^^^^^^ | ||
| .. automodule:: mmhuman3d.data | ||
| :members: | ||
|
|
||
| datasets | ||
| ^^^^^^^^^ | ||
| .. automodule:: mmhuman3d.data.datasets | ||
| :members: | ||
|
|
||
| data_converters | ||
| ^^^^^^^^^^^^^^^ | ||
| .. automodule:: mmhuman3d.data.data_converters | ||
| :members: | ||
|
|
||
| data_structures | ||
| ^^^^^^^^^^^^^^^ | ||
| .. automodule:: mmhuman3d.data.data_structures | ||
| :members: | ||
|
|
||
| mmhuman3d.utils | ||
| --------------- | ||
| .. automodule:: mmhuman3d.utils | ||
| :members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| # 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 pytorch_sphinx_theme | ||
|
|
||
| sys.path.insert(0, os.path.abspath('..')) | ||
|
|
||
| # -- Project information ----------------------------------------------------- | ||
|
|
||
| project = 'MMHuman3D' | ||
| copyright = '2018-2021, OpenMMLab' | ||
| author = 'MMHuman3D Authors' | ||
| version_file = '../mmhuman3d/version.py' | ||
|
|
||
|
|
||
| def get_version(): | ||
| with open(version_file, 'r') as f: | ||
| exec(compile(f.read(), version_file, 'exec')) | ||
| return locals()['__version__'] | ||
|
|
||
|
|
||
| # The full version, including alpha/beta/rc tags | ||
| release = get_version() | ||
|
|
||
| # -- 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.ext.autodoc', | ||
| 'sphinx.ext.napoleon', | ||
| 'sphinx.ext.viewcode', | ||
| 'sphinx_markdown_tables', | ||
| 'sphinx_copybutton', | ||
| 'myst_parser' | ||
| ] | ||
|
|
||
| autodoc_mock_imports = [ | ||
| 'mmhuman3d.version', 'mmcv.ops' | ||
| ] | ||
|
|
||
| # Ignore >>> when copying code | ||
| copybutton_prompt_text = r'>>> |\.\.\. ' | ||
| copybutton_prompt_is_regexp = True | ||
|
|
||
| # 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': 'restructuredtext', | ||
| '.md': 'markdown', | ||
| } | ||
|
|
||
| # 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 = 'pytorch_sphinx_theme' | ||
| html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()] | ||
|
|
||
| html_theme_options = { | ||
| 'menu': [ | ||
| { | ||
| 'name': 'GitHub', | ||
| 'url': 'https://github.com/open-mmlab/mmdetection' | ||
| }, | ||
| { | ||
| 'name': | ||
| 'Projects', | ||
| 'children': [ | ||
| { | ||
| 'name': 'MMAction2', | ||
| 'url': 'https://github.com/open-mmlab/mmaction2', | ||
| }, | ||
| { | ||
| 'name': 'MMClassification', | ||
| 'url': 'https://github.com/open-mmlab/mmclassification', | ||
| }, | ||
| { | ||
| 'name': 'MMDetection', | ||
| 'url': 'https://github.com/open-mmlab/mmdetection', | ||
| }, | ||
| { | ||
| 'name': 'MMDetection3D', | ||
| 'url': 'https://github.com/open-mmlab/mmdetection3d', | ||
| }, | ||
| { | ||
| 'name': 'MMEditing', | ||
| 'url': 'https://github.com/open-mmlab/mmediting', | ||
| }, | ||
| { | ||
| 'name': 'MMGeneration', | ||
| 'url': 'https://github.com/open-mmlab/mmgeneration', | ||
| }, | ||
| { | ||
| 'name': 'MMOCR', | ||
| 'url': 'https://github.com/open-mmlab/mmocr', | ||
| }, | ||
| { | ||
| 'name': 'MMPose', | ||
| 'url': 'https://github.com/open-mmlab/mmpose', | ||
| }, | ||
| { | ||
| 'name': 'MMSegmentation', | ||
| 'url': 'https://github.com/open-mmlab/mmsegmentation', | ||
| }, | ||
| { | ||
| 'name': 'MMTracking', | ||
| 'url': 'https://github.com/open-mmlab/mmtracking', | ||
| }, | ||
| { | ||
| 'name': 'MMFlow', | ||
| 'url': 'https://github.com/open-mmlab/mmflow', | ||
| }, | ||
| { | ||
| 'name': 'MMHuman3D', | ||
| 'url': 'https://github.com/open-mmlab/mmhuman3d', | ||
| }, | ||
| ] | ||
| }, | ||
| { | ||
| 'name': | ||
| 'OpenMMLab', | ||
| 'children': [ | ||
| { | ||
| 'name': 'Homepage', | ||
| 'url': 'https://openmmlab.com/' | ||
| }, | ||
| { | ||
| 'name': 'GitHub', | ||
| 'url': 'https://github.com/open-mmlab/' | ||
| }, | ||
| { | ||
| 'name': 'Twitter', | ||
| 'url': 'https://twitter.com/OpenMMLab' | ||
| }, | ||
| { | ||
| 'name': 'Zhihu', | ||
| 'url': 'https://zhihu.com/people/openmmlab' | ||
| }, | ||
| ] | ||
| }, | ||
| ] | ||
| } | ||
|
|
||
| # 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/readthedocs.css'] | ||
|
|
||
| # Enable ::: for my_st | ||
| myst_enable_extensions = ['colon_fence'] | ||
|
|
||
| master_doc = 'index' |
Oops, something went wrong.