From cf4ba5cb7f30d6a710e4516e5d1dbdc19982659c Mon Sep 17 00:00:00 2001 From: Alexander Artemenko Date: Wed, 3 Feb 2021 22:26:14 +0300 Subject: [PATCH] Removed old docs. --- TEST.md | 8 - docs/Makefile | 153 ------------------ docs/requirements.in | 10 -- docs/requirements.txt | 30 ---- docs/source/_static/.keep | 0 docs/source/api.rst | 30 ---- docs/source/changelog.rst | 1 - docs/source/conf.py | 324 -------------------------------------- docs/source/index.rst | 40 ----- tasks.py | 42 ----- 10 files changed, 638 deletions(-) delete mode 100644 TEST.md delete mode 100644 docs/Makefile delete mode 100644 docs/requirements.in delete mode 100644 docs/requirements.txt delete mode 100644 docs/source/_static/.keep delete mode 100644 docs/source/api.rst delete mode 100644 docs/source/changelog.rst delete mode 100644 docs/source/conf.py delete mode 100644 docs/source/index.rst delete mode 100644 tasks.py diff --git a/TEST.md b/TEST.md deleted file mode 100644 index 8544ec4..0000000 --- a/TEST.md +++ /dev/null @@ -1,8 +0,0 @@ -Before iframe - - - -AFTER diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 332cc8b..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,153 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/cl-info.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/cl-info.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/cl-info" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/cl-info" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." diff --git a/docs/requirements.in b/docs/requirements.in deleted file mode 100644 index ebbb6a1..0000000 --- a/docs/requirements.in +++ /dev/null @@ -1,10 +0,0 @@ -# to build documentation -sphinx -pygments-cl-repl -sphinx-bootstrap-theme - -# to support docstring extraction and cross-referencing --e git+git@github.com:russell/sphinxcontrib-cldomain.git#egg=sphinxcontrib-cldomain - -# to run commands from tasks.py -invoke diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 06f074b..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,30 +0,0 @@ -# -# This file is autogenerated by pip-compile -# To update, run: -# -# pip-compile --output-file requirements.txt requirements.in -# - --e git+git@github.com:russell/sphinxcontrib-cldomain.git#egg=sphinxcontrib-cldomain -alabaster==0.7.10 # via sphinx -appdirs==1.4.3 # via setuptools -babel==2.4.0 # via sphinx -docutils==0.13.1 # via sphinx -imagesize==0.7.1 # via sphinx -invoke==0.15.0 -Jinja2==2.9.6 # via sphinx -MarkupSafe==1.0 # via jinja2 -packaging==16.8 # via setuptools -pygments-cl-repl==0.1 -pygments==2.2.0 # via pygments-cl-repl, sphinx -pyparsing==2.2.0 # via packaging -pytz==2017.2 # via babel -requests==2.13.0 # via sphinx -six==1.10.0 # via packaging, setuptools, sphinx -snowballstemmer==1.2.1 # via sphinx -sphinx-bootstrap-theme==0.4.14 -sphinx==1.5.5 - -# The following packages are commented out because they are -# considered to be unsafe in a requirements file: -# setuptools # via sphinx-bootstrap-theme diff --git a/docs/source/_static/.keep b/docs/source/_static/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/source/api.rst b/docs/source/api.rst deleted file mode 100644 index ceeb5a2..0000000 --- a/docs/source/api.rst +++ /dev/null @@ -1,30 +0,0 @@ -===== - API -===== - -Here you can describe an API. - -Use `cldomain's `_ directives, to insert -functions or macroses descriptions, like that: - -.. cl:package:: cl-info - -.. cl:function:: foo - -.. cl:macro:: bar - - Also you can specify additional examples for some blocks: - - .. code-block:: common-lisp-repl - - TEST> (bar 1 2 3) - - (1 2 3) - NIL - -And because this is Sphinx, you can use it's great cross-referencing -features to link to functions. Here is the link to -:cl:function:`cl-info:foo`. - -Read the documentation on `cldomain `_ and -write your own beautiful docs! diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst deleted file mode 100644 index 705b295..0000000 --- a/docs/source/changelog.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../ChangeLog.rst diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index e94b28f..0000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,324 +0,0 @@ -# -*- coding: utf-8 -*- -# -# cl-info documentation build configuration file, created by -# sphinx-quickstart on Sat Apr 8 20:18:20 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. - -import sys, os - -# 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. -#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.autodoc', - # 'sphinx.ext.doctest', - # 'sphinx.ext.viewcode', - # 'sphinx.ext.intersphinx', - - # creates .nojekyll file on generated HTML directory - 'sphinx.ext.githubpages', - # Allow reference sections using its title - # http://www.sphinx-doc.org/en/stable/ext/autosectionlabel.html - 'sphinx.ext.autosectionlabel', - 'sphinxcontrib.cldomain', - 'sphinxcontrib.hyperspec', -] - -from os.path import join, dirname, realpath, expandvars -cl_systems = [ - { - 'name': 'cl-info-test', - 'path': join(dirname(realpath(__file__)), '../../'), - 'packages': [ - 'cl-info', - ] - }, -] - -cl_quicklisp = expandvars('$HOME/quicklisp/') - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'cl-info' -copyright = u'2017, ' - -# 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 full version, including alpha/beta/rc tags. -release = open(join(dirname(__file__), "../..", - "version.lisp-expr")).read().strip().strip('"') -# The short X.Y version. -version = '.'.join(release.split('.')[:2]) - - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -highlight_language = 'common-lisp' -pygments_style = 'emacs' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- Options for HTML output --------------------------------------------------- - -import sphinx_bootstrap_theme -html_theme = 'bootstrap' - -# почему-то в модуле его нет -#html_translator_class = 'sphinx_bootstrap_theme.BootstrapTranslator' - -html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() - -html_theme_options = { - # Navigation bar title. (Default: ``project`` value) - # 'navbar_title': "Demo", - - 'navbar_sidebarrel': False, - - 'navbar_pagenav': False, - - # Tab name for entire site. (Default: "Site") - "navbar_site_name": "Contents", - - # Global TOC depth for "site" navbar tab. (Default: 1) - # Switching to -1 shows all levels. - # 'globaltoc_depth': 2, - - # Include hidden TOCs in Site navbar? - # - # Note: If this is "false", you cannot have mixed ``:hidden:`` and - # non-hidden ``toctree`` directives in the same page, or else the build - # will break. - # - # Values: "true" (default) or "false" - # 'globaltoc_includehidden': "true", - - # HTML navbar class (Default: "navbar") to attach to
element. - # For black navbar, do "navbar navbar-inverse" - # 'navbar_class': "navbar navbar-inverse", - 'navbar_site_name': "Documentation", - - 'navbar_links': [("Changelog", "changelog")], - - # Fix navigation bar to top of page? - # Values: "true" (default) or "false" - # 'navbar_fixed_top': "true", - - # Location of link to source. - # Options are "nav" (default), "footer" or anything else to exclude. - 'source_link_position': "footer", - - # Bootswatch (http://bootswatch.com/) theme. - # - # Options are nothing with "" (default) or the name of a valid theme - # such as "amelia" or "cosmo". - # - # Note that this is served off CDN, so won't be available offline. - 'bootswatch_theme': "yeti", -} - -# 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. - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = ["_themes/"] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# 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 -# pixels large. -#html_favicon = None - -# 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'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} -html_sidebars = {'**': ['localtoc.html'], - 'search': None, - 'glossary': None} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'cl-infodoc' - -# -- 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': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'cl-info.tex', u'cl-info Documentation', - u'', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output -------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'cl-info', u'cl-info Documentation', - [u''], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- 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 = [ - ('index', 'cl-info', u'cl-info Documentation', - u'', 'cl-info', '', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index e7865df..0000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,40 +0,0 @@ -========================================= - Welcome to cl-info's documentation! -========================================= - -This is an implementation of Hamcrest for Common Lisp. - -Here are some examples ----------------------- - - -.. code-block:: common-lisp-repl - - GIT> (assert-that - log-item - (has-plist-entries :|@message| "Some" - :|@timestamp| _) - (hasnt-plist-keys :|@fields|)) - -.. include:: ../../README.rst - :start-after: include-from - :end-before: include-to - -Contents -======== - -.. toctree:: - :maxdepth: 2 - - api - changelog - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - - diff --git a/tasks.py b/tasks.py deleted file mode 100644 index 7ddd766..0000000 --- a/tasks.py +++ /dev/null @@ -1,42 +0,0 @@ -import os -import sys - -from invoke import task, run - - -@task -def build_docs(ctx): - """Builds html documentation and updates gh-pages branch. - """ - def git(cmd): - return run('cd docs/build/html && git {0}'.format(cmd)) - - # build docs - run('cd docs && make html') - - # If project's directory is git repository - if os.path.exists('.git'): - # if no git repository in docs/build/html, - # then init one - if not os.path.exists('docs/build/html/.git'): - result = run("git remote -v | grep '^origin.*(push)$'", warn=True) - - if result.failed: - print('There is no "origin" remote in this git repository.') - print('Please, add remote and push it to the Github.') - sys.exit(1) - else: - origin = result.stdout.strip().split()[1] - git('init') - git('remote add origin {0}'.format(origin)) - - git('add .') - git('commit -m "Update docs"') - git('push --force origin master:gh-pages') - else: - # If project's directory is not a repository - # then we don't know where to push the docs. - print('This project is not a git repository.') - print('Please, push it to the GitHub and run this command') - print('again. Then we\'ll be able to update gh-pages branch.') - sys.exit(1)