diff options
Diffstat (limited to 'docs/sphinx')
38 files changed, 833 insertions, 20 deletions
diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py index 3cd48af..dbc21dd 100644 --- a/docs/sphinx/conf.py +++ b/docs/sphinx/conf.py @@ -27,17 +27,14 @@ from __future__ import unicode_literals # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -try: - import sphinxcontrib.gist # NOQA - extensions = ['sphinxcontrib.gist'] -except ImportError: - extensions = [] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.mathjax'] +# extensions.append('sphinxcontrib.gist') # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. -source_suffix = '.txt' +source_suffix = '.rst' # The encoding of source files. # source_encoding = 'utf-8-sig' @@ -47,16 +44,16 @@ master_doc = 'index' # General information about the project. project = 'Nikola' -copyright = '2012-2015, The Nikola Contributors' +copyright = '2012-2020, The Nikola Contributors' # The version info for the project yo'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 = '7.6.4' +version = '8.1.2' # The full version, including alpha/beta/rc tags. -release = '7.6.4' +release = '8.1.2' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -120,7 +117,7 @@ html_theme = 'default' # The name of an image file (relative to this directory) to place at the top # of the sidebar. -# html_logo = None +html_logo = "../../logo/nikola-50px-transparent.png" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 @@ -244,7 +241,7 @@ man_pages = [ # dir menu entry, description, category) texinfo_documents = [ ('index', 'Nikola', 'Nikola Documentation', - 'The Nikola Contributors', 'Nikola', 'One line description of project.', + 'The Nikola Contributors', 'Nikola', 'A static site generator.', 'Miscellaneous'), ] diff --git a/docs/sphinx/creating-a-site.rst b/docs/sphinx/creating-a-site.rst new file mode 120000 index 0000000..2eb5b8d --- /dev/null +++ b/docs/sphinx/creating-a-site.rst @@ -0,0 +1 @@ +../creating-a-site.rst
\ No newline at end of file diff --git a/docs/sphinx/creating-a-site.txt b/docs/sphinx/creating-a-site.txt deleted file mode 120000 index 85f2ab2..0000000 --- a/docs/sphinx/creating-a-site.txt +++ /dev/null @@ -1 +0,0 @@ -../creating-a-site.txt
\ No newline at end of file diff --git a/docs/sphinx/creating-a-theme.rst b/docs/sphinx/creating-a-theme.rst new file mode 120000 index 0000000..3723833 --- /dev/null +++ b/docs/sphinx/creating-a-theme.rst @@ -0,0 +1 @@ +../creating-a-theme.rst
\ No newline at end of file diff --git a/docs/sphinx/creating-a-theme.txt b/docs/sphinx/creating-a-theme.txt deleted file mode 120000 index 6ddf35a..0000000 --- a/docs/sphinx/creating-a-theme.txt +++ /dev/null @@ -1 +0,0 @@ -../creating-a-theme.txt
\ No newline at end of file diff --git a/docs/sphinx/extending.rst b/docs/sphinx/extending.rst new file mode 120000 index 0000000..8078fc4 --- /dev/null +++ b/docs/sphinx/extending.rst @@ -0,0 +1 @@ +../extending.rst
\ No newline at end of file diff --git a/docs/sphinx/extending.txt b/docs/sphinx/extending.txt deleted file mode 120000 index 1da5af1..0000000 --- a/docs/sphinx/extending.txt +++ /dev/null @@ -1 +0,0 @@ -../extending.txt
\ No newline at end of file diff --git a/docs/sphinx/index.txt b/docs/sphinx/index.rst index c677caf..b448f76 100644 --- a/docs/sphinx/index.txt +++ b/docs/sphinx/index.rst @@ -5,14 +5,28 @@ Those are the docs for the current GitHub master. It might be incompatible with the stable release. The docs for the stable release are available `on the Nikola website <https://getnikola.com/documentation.html>`_. +Please note that some examples of Nikola-specific reST syntax might not be +visible in this version of Nikola docs. + .. toctree:: :maxdepth: 5 + :numbered: + :caption: Nikola Documentation manual creating-a-site - creating-a-theme + Creating a Theme <creating-a-theme> theming + template-variables extending internals - tests social_buttons + path_handlers + +.. toctree:: + :maxdepth: 5 + :numbered: + :caption: Autogenerated Code Documentation + + Code Documentation <modules> + diff --git a/docs/sphinx/internals.rst b/docs/sphinx/internals.rst new file mode 120000 index 0000000..44afd4d --- /dev/null +++ b/docs/sphinx/internals.rst @@ -0,0 +1 @@ +../internals.rst
\ No newline at end of file diff --git a/docs/sphinx/internals.txt b/docs/sphinx/internals.txt deleted file mode 120000 index f0f3f05..0000000 --- a/docs/sphinx/internals.txt +++ /dev/null @@ -1 +0,0 @@ -../internals.txt
\ No newline at end of file diff --git a/docs/sphinx/manual.rst b/docs/sphinx/manual.rst new file mode 120000 index 0000000..bf5c954 --- /dev/null +++ b/docs/sphinx/manual.rst @@ -0,0 +1 @@ +../manual.rst
\ No newline at end of file diff --git a/docs/sphinx/manual.txt b/docs/sphinx/manual.txt deleted file mode 120000 index df591d6..0000000 --- a/docs/sphinx/manual.txt +++ /dev/null @@ -1 +0,0 @@ -../manual.txt
\ No newline at end of file diff --git a/docs/sphinx/modules.rst b/docs/sphinx/modules.rst new file mode 100644 index 0000000..e310225 --- /dev/null +++ b/docs/sphinx/modules.rst @@ -0,0 +1,7 @@ +nikola +====== + +.. toctree:: + :maxdepth: 4 + + nikola diff --git a/docs/sphinx/nikola.packages.datecond.rst b/docs/sphinx/nikola.packages.datecond.rst new file mode 100644 index 0000000..d5aeead --- /dev/null +++ b/docs/sphinx/nikola.packages.datecond.rst @@ -0,0 +1,7 @@ +nikola.packages.datecond package +================================ + +.. automodule:: nikola.packages.datecond + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/sphinx/nikola.packages.pygments_better_html.rst b/docs/sphinx/nikola.packages.pygments_better_html.rst new file mode 100644 index 0000000..41b5b94 --- /dev/null +++ b/docs/sphinx/nikola.packages.pygments_better_html.rst @@ -0,0 +1,7 @@ +nikola.packages.pygments\_better\_html package +============================================== + +.. automodule:: nikola.packages.pygments_better_html + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/sphinx/nikola.packages.rst b/docs/sphinx/nikola.packages.rst new file mode 100644 index 0000000..916b3ec --- /dev/null +++ b/docs/sphinx/nikola.packages.rst @@ -0,0 +1,17 @@ +nikola.packages package +======================= + +.. automodule:: nikola.packages + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + nikola.packages.datecond + nikola.packages.pygments_better_html + nikola.packages.tzlocal diff --git a/docs/sphinx/nikola.packages.tzlocal.rst b/docs/sphinx/nikola.packages.tzlocal.rst new file mode 100644 index 0000000..944562e --- /dev/null +++ b/docs/sphinx/nikola.packages.tzlocal.rst @@ -0,0 +1,35 @@ +nikola.packages.tzlocal package +=============================== + +.. automodule:: nikola.packages.tzlocal + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +nikola.packages.tzlocal.unix module +----------------------------------- + +.. automodule:: nikola.packages.tzlocal.unix + :members: + :undoc-members: + :show-inheritance: + +nikola.packages.tzlocal.win32 module +------------------------------------ + +.. automodule:: nikola.packages.tzlocal.win32 + :members: + :undoc-members: + :show-inheritance: + +nikola.packages.tzlocal.windows\_tz module +------------------------------------------ + +.. automodule:: nikola.packages.tzlocal.windows_tz + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/sphinx/nikola.plugins.command.auto.rst b/docs/sphinx/nikola.plugins.command.auto.rst new file mode 100644 index 0000000..e597ff0 --- /dev/null +++ b/docs/sphinx/nikola.plugins.command.auto.rst @@ -0,0 +1,7 @@ +nikola.plugins.command.auto package +=================================== + +.. automodule:: nikola.plugins.command.auto + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/sphinx/nikola.plugins.command.rst b/docs/sphinx/nikola.plugins.command.rst new file mode 100644 index 0000000..8c97515 --- /dev/null +++ b/docs/sphinx/nikola.plugins.command.rst @@ -0,0 +1,148 @@ +nikola.plugins.command package +============================== + +.. automodule:: nikola.plugins.command + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + nikola.plugins.command.auto + nikola.plugins.command.rst2html + +Submodules +---------- + +nikola.plugins.command.check module +----------------------------------- + +.. automodule:: nikola.plugins.command.check + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.command.console module +------------------------------------- + +.. automodule:: nikola.plugins.command.console + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.command.default\_config module +--------------------------------------------- + +.. automodule:: nikola.plugins.command.default_config + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.command.deploy module +------------------------------------ + +.. automodule:: nikola.plugins.command.deploy + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.command.github\_deploy module +-------------------------------------------- + +.. automodule:: nikola.plugins.command.github_deploy + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.command.import\_wordpress module +----------------------------------------------- + +.. automodule:: nikola.plugins.command.import_wordpress + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.command.init module +---------------------------------- + +.. automodule:: nikola.plugins.command.init + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.command.new\_page module +--------------------------------------- + +.. automodule:: nikola.plugins.command.new_page + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.command.new\_post module +--------------------------------------- + +.. automodule:: nikola.plugins.command.new_post + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.command.orphans module +------------------------------------- + +.. automodule:: nikola.plugins.command.orphans + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.command.plugin module +------------------------------------ + +.. automodule:: nikola.plugins.command.plugin + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.command.serve module +----------------------------------- + +.. automodule:: nikola.plugins.command.serve + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.command.status module +------------------------------------ + +.. automodule:: nikola.plugins.command.status + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.command.subtheme module +-------------------------------------- + +.. automodule:: nikola.plugins.command.subtheme + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.command.theme module +----------------------------------- + +.. automodule:: nikola.plugins.command.theme + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.command.version module +------------------------------------- + +.. automodule:: nikola.plugins.command.version + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/sphinx/nikola.plugins.command.rst2html.rst b/docs/sphinx/nikola.plugins.command.rst2html.rst new file mode 100644 index 0000000..492d0a5 --- /dev/null +++ b/docs/sphinx/nikola.plugins.command.rst2html.rst @@ -0,0 +1,7 @@ +nikola.plugins.command.rst2html package +======================================= + +.. automodule:: nikola.plugins.command.rst2html + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/sphinx/nikola.plugins.compile.markdown.rst b/docs/sphinx/nikola.plugins.compile.markdown.rst new file mode 100644 index 0000000..b27da4e --- /dev/null +++ b/docs/sphinx/nikola.plugins.compile.markdown.rst @@ -0,0 +1,35 @@ +nikola.plugins.compile.markdown package +======================================= + +.. automodule:: nikola.plugins.compile.markdown + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +nikola.plugins.compile.markdown.mdx\_gist module +------------------------------------------------ + +.. automodule:: nikola.plugins.compile.markdown.mdx_gist + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.compile.markdown.mdx\_nikola module +-------------------------------------------------- + +.. automodule:: nikola.plugins.compile.markdown.mdx_nikola + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.compile.markdown.mdx\_podcast module +--------------------------------------------------- + +.. automodule:: nikola.plugins.compile.markdown.mdx_podcast + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/sphinx/nikola.plugins.compile.rest.rst b/docs/sphinx/nikola.plugins.compile.rest.rst new file mode 100644 index 0000000..3f5d0bd --- /dev/null +++ b/docs/sphinx/nikola.plugins.compile.rest.rst @@ -0,0 +1,91 @@ +nikola.plugins.compile.rest package +=================================== + +.. automodule:: nikola.plugins.compile.rest + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +nikola.plugins.compile.rest.chart module +---------------------------------------- + +.. automodule:: nikola.plugins.compile.rest.chart + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.compile.rest.doc module +-------------------------------------- + +.. automodule:: nikola.plugins.compile.rest.doc + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.compile.rest.gist module +--------------------------------------- + +.. automodule:: nikola.plugins.compile.rest.gist + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.compile.rest.listing module +------------------------------------------ + +.. automodule:: nikola.plugins.compile.rest.listing + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.compile.rest.media module +---------------------------------------- + +.. automodule:: nikola.plugins.compile.rest.media + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.compile.rest.post\_list module +--------------------------------------------- + +.. automodule:: nikola.plugins.compile.rest.post_list + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.compile.rest.soundcloud module +--------------------------------------------- + +.. automodule:: nikola.plugins.compile.rest.soundcloud + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.compile.rest.thumbnail module +-------------------------------------------- + +.. automodule:: nikola.plugins.compile.rest.thumbnail + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.compile.rest.vimeo module +---------------------------------------- + +.. automodule:: nikola.plugins.compile.rest.vimeo + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.compile.rest.youtube module +------------------------------------------ + +.. automodule:: nikola.plugins.compile.rest.youtube + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/sphinx/nikola.plugins.compile.rst b/docs/sphinx/nikola.plugins.compile.rst new file mode 100644 index 0000000..e89de36 --- /dev/null +++ b/docs/sphinx/nikola.plugins.compile.rst @@ -0,0 +1,52 @@ +nikola.plugins.compile package +============================== + +.. automodule:: nikola.plugins.compile + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + nikola.plugins.compile.markdown + nikola.plugins.compile.rest + +Submodules +---------- + +nikola.plugins.compile.html module +---------------------------------- + +.. automodule:: nikola.plugins.compile.html + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.compile.ipynb module +----------------------------------- + +.. automodule:: nikola.plugins.compile.ipynb + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.compile.pandoc module +------------------------------------ + +.. automodule:: nikola.plugins.compile.pandoc + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.compile.php module +--------------------------------- + +.. automodule:: nikola.plugins.compile.php + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/sphinx/nikola.plugins.misc.rst b/docs/sphinx/nikola.plugins.misc.rst new file mode 100644 index 0000000..2cab79e --- /dev/null +++ b/docs/sphinx/nikola.plugins.misc.rst @@ -0,0 +1,27 @@ +nikola.plugins.misc package +=========================== + +.. automodule:: nikola.plugins.misc + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +nikola.plugins.misc.scan\_posts module +-------------------------------------- + +.. automodule:: nikola.plugins.misc.scan_posts + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.misc.taxonomies\_classifier module +------------------------------------------------- + +.. automodule:: nikola.plugins.misc.taxonomies_classifier + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/sphinx/nikola.plugins.rst b/docs/sphinx/nikola.plugins.rst new file mode 100644 index 0000000..f3e8680 --- /dev/null +++ b/docs/sphinx/nikola.plugins.rst @@ -0,0 +1,31 @@ +nikola.plugins package +====================== + +.. automodule:: nikola.plugins + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + nikola.plugins.command + nikola.plugins.compile + nikola.plugins.misc + nikola.plugins.task + nikola.plugins.template + +Submodules +---------- + +nikola.plugins.basic\_import module +----------------------------------- + +.. automodule:: nikola.plugins.basic_import + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/sphinx/nikola.plugins.task.rst b/docs/sphinx/nikola.plugins.task.rst new file mode 100644 index 0000000..327887a --- /dev/null +++ b/docs/sphinx/nikola.plugins.task.rst @@ -0,0 +1,171 @@ +nikola.plugins.task package +=========================== + +.. automodule:: nikola.plugins.task + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +nikola.plugins.task.archive module +---------------------------------- + +.. automodule:: nikola.plugins.task.archive + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.authors module +---------------------------------- + +.. automodule:: nikola.plugins.task.authors + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.bundles module +---------------------------------- + +.. automodule:: nikola.plugins.task.bundles + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.categories module +------------------------------------- + +.. automodule:: nikola.plugins.task.categories + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.copy\_assets module +--------------------------------------- + +.. automodule:: nikola.plugins.task.copy_assets + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.copy\_files module +-------------------------------------- + +.. automodule:: nikola.plugins.task.copy_files + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.galleries module +------------------------------------ + +.. automodule:: nikola.plugins.task.galleries + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.gzip module +------------------------------- + +.. automodule:: nikola.plugins.task.gzip + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.indexes module +---------------------------------- + +.. automodule:: nikola.plugins.task.indexes + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.listings module +----------------------------------- + +.. automodule:: nikola.plugins.task.listings + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.page\_index module +-------------------------------------- + +.. automodule:: nikola.plugins.task.page_index + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.pages module +-------------------------------- + +.. automodule:: nikola.plugins.task.pages + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.posts module +-------------------------------- + +.. automodule:: nikola.plugins.task.posts + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.redirect module +----------------------------------- + +.. automodule:: nikola.plugins.task.redirect + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.robots module +--------------------------------- + +.. automodule:: nikola.plugins.task.robots + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.scale\_images module +---------------------------------------- + +.. automodule:: nikola.plugins.task.scale_images + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.sitemap module +---------------------------------- + +.. automodule:: nikola.plugins.task.sitemap + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.sources module +---------------------------------- + +.. automodule:: nikola.plugins.task.sources + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.tags module +------------------------------- + +.. automodule:: nikola.plugins.task.tags + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.task.taxonomies module +------------------------------------- + +.. automodule:: nikola.plugins.task.taxonomies + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/sphinx/nikola.plugins.task.sitemap.rst b/docs/sphinx/nikola.plugins.task.sitemap.rst new file mode 100644 index 0000000..774b09a --- /dev/null +++ b/docs/sphinx/nikola.plugins.task.sitemap.rst @@ -0,0 +1,10 @@ +nikola.plugins.task.sitemap package +=================================== + +Module contents +--------------- + +.. automodule:: nikola.plugins.task.sitemap + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/sphinx/nikola.plugins.template.rst b/docs/sphinx/nikola.plugins.template.rst new file mode 100644 index 0000000..3d4b05e --- /dev/null +++ b/docs/sphinx/nikola.plugins.template.rst @@ -0,0 +1,27 @@ +nikola.plugins.template package +=============================== + +.. automodule:: nikola.plugins.template + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +nikola.plugins.template.jinja module +------------------------------------ + +.. automodule:: nikola.plugins.template.jinja + :members: + :undoc-members: + :show-inheritance: + +nikola.plugins.template.mako module +----------------------------------- + +.. automodule:: nikola.plugins.template.mako + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/sphinx/nikola.rst b/docs/sphinx/nikola.rst new file mode 100644 index 0000000..28a15c3 --- /dev/null +++ b/docs/sphinx/nikola.rst @@ -0,0 +1,116 @@ +nikola package +============== + +.. automodule:: nikola + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + nikola.packages + nikola.plugins + +Submodules +---------- + +nikola.filters module +--------------------- + +.. automodule:: nikola.filters + :members: + :undoc-members: + :show-inheritance: + +nikola.hierarchy\_utils module +------------------------------ + +.. automodule:: nikola.hierarchy_utils + :members: + :undoc-members: + :show-inheritance: + +nikola.image\_processing module +------------------------------- + +.. automodule:: nikola.image_processing + :members: + :undoc-members: + :show-inheritance: + +nikola.log module +----------------- + +.. automodule:: nikola.log + :members: + :undoc-members: + :show-inheritance: + +nikola.metadata\_extractors module +---------------------------------- + +.. automodule:: nikola.metadata_extractors + :members: + :undoc-members: + :show-inheritance: + +nikola.nikola module +-------------------- + +.. automodule:: nikola.nikola + :members: + :undoc-members: + :show-inheritance: + +nikola.plugin\_categories module +-------------------------------- + +.. automodule:: nikola.plugin_categories + :members: + :undoc-members: + :show-inheritance: + +nikola.post module +------------------ + +.. automodule:: nikola.post + :members: + :undoc-members: + :show-inheritance: + +nikola.shortcodes module +------------------------ + +.. automodule:: nikola.shortcodes + :members: + :undoc-members: + :show-inheritance: + +nikola.state module +------------------- + +.. automodule:: nikola.state + :members: + :undoc-members: + :show-inheritance: + +nikola.utils module +------------------- + +.. automodule:: nikola.utils + :members: + :undoc-members: + :show-inheritance: + +nikola.winutils module +---------------------- + +.. automodule:: nikola.winutils + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/sphinx/path_handlers.rst b/docs/sphinx/path_handlers.rst new file mode 120000 index 0000000..9230f5b --- /dev/null +++ b/docs/sphinx/path_handlers.rst @@ -0,0 +1 @@ +../path_handlers.rst
\ No newline at end of file diff --git a/docs/sphinx/requirements-docs.txt b/docs/sphinx/requirements-docs.txt new file mode 100644 index 0000000..443470f --- /dev/null +++ b/docs/sphinx/requirements-docs.txt @@ -0,0 +1,2 @@ +-r ../../requirements-extras.txt +pyparsing>=2.0.2 diff --git a/docs/sphinx/social_buttons.rst b/docs/sphinx/social_buttons.rst new file mode 120000 index 0000000..ff7a368 --- /dev/null +++ b/docs/sphinx/social_buttons.rst @@ -0,0 +1 @@ +../social_buttons.rst
\ No newline at end of file diff --git a/docs/sphinx/social_buttons.txt b/docs/sphinx/social_buttons.txt deleted file mode 120000 index 12021c1..0000000 --- a/docs/sphinx/social_buttons.txt +++ /dev/null @@ -1 +0,0 @@ -../social_buttons.txt
\ No newline at end of file diff --git a/docs/sphinx/support.rst b/docs/sphinx/support.rst new file mode 120000 index 0000000..1970f58 --- /dev/null +++ b/docs/sphinx/support.rst @@ -0,0 +1 @@ +../support.rst
\ No newline at end of file diff --git a/docs/sphinx/template-variables.rst b/docs/sphinx/template-variables.rst new file mode 120000 index 0000000..524a0ed --- /dev/null +++ b/docs/sphinx/template-variables.rst @@ -0,0 +1 @@ +../template-variables.rst
\ No newline at end of file diff --git a/docs/sphinx/theming.rst b/docs/sphinx/theming.rst new file mode 120000 index 0000000..6b552b6 --- /dev/null +++ b/docs/sphinx/theming.rst @@ -0,0 +1 @@ +../theming.rst
\ No newline at end of file diff --git a/docs/sphinx/theming.txt b/docs/sphinx/theming.txt deleted file mode 120000 index ed5f3b3..0000000 --- a/docs/sphinx/theming.txt +++ /dev/null @@ -1 +0,0 @@ -../theming.txt
\ No newline at end of file diff --git a/docs/sphinx/update-modules.sh b/docs/sphinx/update-modules.sh new file mode 100755 index 0000000..b3bd094 --- /dev/null +++ b/docs/sphinx/update-modules.sh @@ -0,0 +1,2 @@ +#!/bin/bash +sphinx-apidoc -Mfo . ../../nikola |