diff options
Diffstat (limited to 'docs/sphinx')
46 files changed, 608 insertions, 606 deletions
diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py index 40594aa..dbc21dd 100644 --- a/docs/sphinx/conf.py +++ b/docs/sphinx/conf.py @@ -34,7 +34,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.mathjax'] templates_path = ['_templates'] # The suffix of source filenames. -source_suffix = '.txt' +source_suffix = '.rst' # The encoding of source files. # source_encoding = 'utf-8-sig' @@ -44,16 +44,16 @@ master_doc = 'index' # General information about the project. project = 'Nikola' -copyright = '2012-2016, 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.8.1' +version = '8.1.2' # The full version, including alpha/beta/rc tags. -release = '7.8.1' +release = '8.1.2' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -117,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 @@ -241,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 5a63d5a..b448f76 100644 --- a/docs/sphinx/index.txt +++ b/docs/sphinx/index.rst @@ -10,14 +10,23 @@ visible in this version of Nikola docs. .. toctree:: :maxdepth: 5 + :numbered: + :caption: Nikola Documentation manual creating-a-site Creating a Theme <creating-a-theme> theming + template-variables extending internals 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.txt b/docs/sphinx/modules.rst index e310225..e310225 100644 --- a/docs/sphinx/modules.txt +++ b/docs/sphinx/modules.rst diff --git a/docs/sphinx/nikola.packages.datecond.txt b/docs/sphinx/nikola.packages.datecond.rst index bfb59b5..d5aeead 100644 --- a/docs/sphinx/nikola.packages.datecond.txt +++ b/docs/sphinx/nikola.packages.datecond.rst @@ -1,10 +1,7 @@ nikola.packages.datecond package ================================ -Module contents ---------------- - .. automodule:: nikola.packages.datecond - :members: - :undoc-members: - :show-inheritance: + :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.txt b/docs/sphinx/nikola.packages.txt deleted file mode 100644 index 3162d85..0000000 --- a/docs/sphinx/nikola.packages.txt +++ /dev/null @@ -1,18 +0,0 @@ -nikola.packages package -======================= - -Subpackages ------------ - -.. toctree:: - - nikola.packages.datecond - nikola.packages.tzlocal - -Module contents ---------------- - -.. automodule:: nikola.packages - :members: - :undoc-members: - :show-inheritance: 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.packages.tzlocal.txt b/docs/sphinx/nikola.packages.tzlocal.txt deleted file mode 100644 index 2002afc..0000000 --- a/docs/sphinx/nikola.packages.tzlocal.txt +++ /dev/null @@ -1,46 +0,0 @@ -nikola.packages.tzlocal package -=============================== - -Submodules ----------- - -nikola.packages.tzlocal.darwin module -------------------------------------- - -.. automodule:: nikola.packages.tzlocal.darwin - :members: - :undoc-members: - :show-inheritance: - -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: - - -Module contents ---------------- - -.. automodule:: nikola.packages.tzlocal - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sphinx/nikola.plugins.command.auto.txt b/docs/sphinx/nikola.plugins.command.auto.rst index 59f9dcb..e597ff0 100644 --- a/docs/sphinx/nikola.plugins.command.auto.txt +++ b/docs/sphinx/nikola.plugins.command.auto.rst @@ -1,10 +1,7 @@ nikola.plugins.command.auto package =================================== -Module contents ---------------- - .. automodule:: nikola.plugins.command.auto - :members: - :undoc-members: - :show-inheritance: + :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.txt b/docs/sphinx/nikola.plugins.command.rst2html.rst index b6d7a81..492d0a5 100644 --- a/docs/sphinx/nikola.plugins.command.rst2html.txt +++ b/docs/sphinx/nikola.plugins.command.rst2html.rst @@ -1,10 +1,7 @@ nikola.plugins.command.rst2html package ======================================= -Module contents ---------------- - .. automodule:: nikola.plugins.command.rst2html - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/sphinx/nikola.plugins.command.txt b/docs/sphinx/nikola.plugins.command.txt deleted file mode 100644 index 653c2f4..0000000 --- a/docs/sphinx/nikola.plugins.command.txt +++ /dev/null @@ -1,150 +0,0 @@ -nikola.plugins.command package -============================== - -Subpackages ------------ - -.. toctree:: - - nikola.plugins.command.auto - nikola.plugins.command.rst2html - -Submodules ----------- - -nikola.plugins.command.bootswatch_theme module ----------------------------------------------- - -.. automodule:: nikola.plugins.command.bootswatch_theme - :members: - :undoc-members: - :show-inheritance: - -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.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.install_theme module -------------------------------------------- - -.. automodule:: nikola.plugins.command.install_theme - :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.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: - - -Module contents ---------------- - -.. automodule:: nikola.plugins.command - :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.markdown.txt b/docs/sphinx/nikola.plugins.compile.markdown.txt deleted file mode 100644 index 47e2a0a..0000000 --- a/docs/sphinx/nikola.plugins.compile.markdown.txt +++ /dev/null @@ -1,38 +0,0 @@ -nikola.plugins.compile.markdown package -======================================= - -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: - - -Module contents ---------------- - -.. automodule:: nikola.plugins.compile.markdown - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sphinx/nikola.plugins.compile.rest.txt b/docs/sphinx/nikola.plugins.compile.rest.rst index a094a80..3f5d0bd 100644 --- a/docs/sphinx/nikola.plugins.compile.rest.txt +++ b/docs/sphinx/nikola.plugins.compile.rest.rst @@ -1,6 +1,11 @@ nikola.plugins.compile.rest package =================================== +.. automodule:: nikola.plugins.compile.rest + :members: + :undoc-members: + :show-inheritance: + Submodules ---------- @@ -8,95 +13,79 @@ nikola.plugins.compile.rest.chart module ---------------------------------------- .. automodule:: nikola.plugins.compile.rest.chart - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.compile.rest.doc module -------------------------------------- .. automodule:: nikola.plugins.compile.rest.doc - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.compile.rest.gist module --------------------------------------- .. automodule:: nikola.plugins.compile.rest.gist - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.compile.rest.listing module ------------------------------------------ .. automodule:: nikola.plugins.compile.rest.listing - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.compile.rest.media module ---------------------------------------- .. automodule:: nikola.plugins.compile.rest.media - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -nikola.plugins.compile.rest.post_list module --------------------------------------------- +nikola.plugins.compile.rest.post\_list module +--------------------------------------------- .. automodule:: nikola.plugins.compile.rest.post_list - :members: - :undoc-members: - :show-inheritance: - -nikola.plugins.compile.rest.slides module ------------------------------------------ - -.. automodule:: nikola.plugins.compile.rest.slides - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.compile.rest.soundcloud module --------------------------------------------- .. automodule:: nikola.plugins.compile.rest.soundcloud - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.compile.rest.thumbnail module -------------------------------------------- .. automodule:: nikola.plugins.compile.rest.thumbnail - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.compile.rest.vimeo module ---------------------------------------- .. automodule:: nikola.plugins.compile.rest.vimeo - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.compile.rest.youtube module ------------------------------------------ .. automodule:: nikola.plugins.compile.rest.youtube - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: -Module contents ---------------- - -.. automodule:: nikola.plugins.compile.rest - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sphinx/nikola.plugins.compile.txt b/docs/sphinx/nikola.plugins.compile.rst index 6a4951b..e89de36 100644 --- a/docs/sphinx/nikola.plugins.compile.txt +++ b/docs/sphinx/nikola.plugins.compile.rst @@ -1,13 +1,19 @@ 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 + nikola.plugins.compile.markdown + nikola.plugins.compile.rest Submodules ---------- @@ -16,39 +22,31 @@ nikola.plugins.compile.html module ---------------------------------- .. automodule:: nikola.plugins.compile.html - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.compile.ipynb module ----------------------------------- .. automodule:: nikola.plugins.compile.ipynb - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.compile.pandoc module ------------------------------------ .. automodule:: nikola.plugins.compile.pandoc - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.compile.php module --------------------------------- .. automodule:: nikola.plugins.compile.php - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: -Module contents ---------------- - -.. automodule:: nikola.plugins.compile - :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.misc.txt b/docs/sphinx/nikola.plugins.misc.txt deleted file mode 100644 index 03786d8..0000000 --- a/docs/sphinx/nikola.plugins.misc.txt +++ /dev/null @@ -1,22 +0,0 @@ -nikola.plugins.misc package -=========================== - -Submodules ----------- - -nikola.plugins.misc.scan_posts module -------------------------------------- - -.. automodule:: nikola.plugins.misc.scan_posts - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: nikola.plugins.misc - :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.txt b/docs/sphinx/nikola.plugins.task.rst index 9a9bcdb..327887a 100644 --- a/docs/sphinx/nikola.plugins.task.txt +++ b/docs/sphinx/nikola.plugins.task.rst @@ -1,12 +1,10 @@ nikola.plugins.task package =========================== -Subpackages ------------ - -.. toctree:: - - nikola.plugins.task.sitemap +.. automodule:: nikola.plugins.task + :members: + :undoc-members: + :show-inheritance: Submodules ---------- @@ -15,151 +13,159 @@ nikola.plugins.task.archive module ---------------------------------- .. automodule:: nikola.plugins.task.archive - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.task.authors module ---------------------------------- .. automodule:: nikola.plugins.task.authors - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.task.bundles module ---------------------------------- .. automodule:: nikola.plugins.task.bundles - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -nikola.plugins.task.copy_assets module --------------------------------------- +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: + :members: + :undoc-members: + :show-inheritance: -nikola.plugins.task.copy_files module -------------------------------------- +nikola.plugins.task.copy\_files module +-------------------------------------- .. automodule:: nikola.plugins.task.copy_files - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.task.galleries module ------------------------------------ .. automodule:: nikola.plugins.task.galleries - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.task.gzip module ------------------------------- .. automodule:: nikola.plugins.task.gzip - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.task.indexes module ---------------------------------- .. automodule:: nikola.plugins.task.indexes - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.task.listings module ----------------------------------- .. automodule:: nikola.plugins.task.listings - :members: - :undoc-members: - :show-inheritance: + :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: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.task.posts module -------------------------------- .. automodule:: nikola.plugins.task.posts - :members: - :undoc-members: - :show-inheritance: - -nikola.plugins.task.py3_switch module -------------------------------------- - -.. automodule:: nikola.plugins.task.py3_switch - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.task.redirect module ----------------------------------- .. automodule:: nikola.plugins.task.redirect - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.task.robots module --------------------------------- .. automodule:: nikola.plugins.task.robots - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: -nikola.plugins.task.rss module ------------------------------- +nikola.plugins.task.scale\_images module +---------------------------------------- -.. automodule:: nikola.plugins.task.rss - :members: - :undoc-members: - :show-inheritance: +.. automodule:: nikola.plugins.task.scale_images + :members: + :undoc-members: + :show-inheritance: -nikola.plugins.task.scale_images module ---------------------------------------- +nikola.plugins.task.sitemap module +---------------------------------- -.. automodule:: nikola.plugins.task.scale_images - :members: - :undoc-members: - :show-inheritance: +.. 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: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.task.tags module ------------------------------- .. automodule:: nikola.plugins.task.tags - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: +nikola.plugins.task.taxonomies module +------------------------------------- -Module contents ---------------- +.. automodule:: nikola.plugins.task.taxonomies + :members: + :undoc-members: + :show-inheritance: -.. automodule:: nikola.plugins.task - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sphinx/nikola.plugins.task.sitemap.txt b/docs/sphinx/nikola.plugins.task.sitemap.rst index 774b09a..774b09a 100644 --- a/docs/sphinx/nikola.plugins.task.sitemap.txt +++ b/docs/sphinx/nikola.plugins.task.sitemap.rst diff --git a/docs/sphinx/nikola.plugins.template.txt b/docs/sphinx/nikola.plugins.template.rst index 48c34e3..3d4b05e 100644 --- a/docs/sphinx/nikola.plugins.template.txt +++ b/docs/sphinx/nikola.plugins.template.rst @@ -1,6 +1,11 @@ nikola.plugins.template package =============================== +.. automodule:: nikola.plugins.template + :members: + :undoc-members: + :show-inheritance: + Submodules ---------- @@ -8,23 +13,15 @@ nikola.plugins.template.jinja module ------------------------------------ .. automodule:: nikola.plugins.template.jinja - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: nikola.plugins.template.mako module ----------------------------------- .. automodule:: nikola.plugins.template.mako - :members: - :undoc-members: - :show-inheritance: - + :members: + :undoc-members: + :show-inheritance: -Module contents ---------------- - -.. automodule:: nikola.plugins.template - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/sphinx/nikola.plugins.txt b/docs/sphinx/nikola.plugins.txt deleted file mode 100644 index ec0f4d1..0000000 --- a/docs/sphinx/nikola.plugins.txt +++ /dev/null @@ -1,33 +0,0 @@ -nikola.plugins package -====================== - -Subpackages ------------ - -.. toctree:: - - 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: - - -Module contents ---------------- - -.. automodule:: nikola.plugins - :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/nikola.txt b/docs/sphinx/nikola.txt deleted file mode 100644 index fda5e0b..0000000 --- a/docs/sphinx/nikola.txt +++ /dev/null @@ -1,102 +0,0 @@ -nikola package -============== - -Subpackages ------------ - -.. toctree:: - - nikola.packages - nikola.plugins - -Submodules ----------- - -nikola.filters module ---------------------- - -.. automodule:: nikola.filters - :members: - :undoc-members: - :show-inheritance: - -nikola.image_processing module ------------------------------- - -.. automodule:: nikola.image_processing - :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.rc4 module ------------------ - -.. automodule:: nikola.rc4 - :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: - - -Module contents ---------------- - -.. automodule:: nikola - :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/path_handlers.txt b/docs/sphinx/path_handlers.txt deleted file mode 120000 index f097a70..0000000 --- a/docs/sphinx/path_handlers.txt +++ /dev/null @@ -1 +0,0 @@ -../path_handlers.txt
\ No newline at end of file diff --git a/docs/sphinx/requirements-docs.txt b/docs/sphinx/requirements-docs.txt index dd22560..443470f 100644 --- a/docs/sphinx/requirements-docs.txt +++ b/docs/sphinx/requirements-docs.txt @@ -1 +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 |