commit 5b3b2a35afd49978eaadf041ee7216cb6d5302f9 Author: Alexander Artemenko Date: Sun Jan 28 01:08:45 2018 +0300 Initial diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ea23d3b --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/docs/build/ +/env/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..894e12f --- /dev/null +++ b/.travis.yml @@ -0,0 +1,53 @@ +language: common-lisp +sudo: false + +cache: + directories: + - $HOME/.roswell + - $HOME/.config/common-lisp + +addons: + apt: + packages: + - libc6-i386 + - openjdk-7-jre +env: + global: + - PATH=~/.roswell/bin:$PATH + - ROSWELL_BRANCH=master + - ROSWELL_INSTALL_DIR=$HOME/.roswell + matrix: + - LISP=sbcl + - LISP=ecl + - LISP=abcl + - LISP=allegro + - LISP=ccl + - LISP=clisp + - LISP=cmucl + +matrix: + allow_failures: + - env: LISP=clisp + - env: LISP=ecl + +os: + - osx + - linux + +install: + - curl -L https://raw.githubusercontent.com/snmsts/roswell/release/scripts/install-for-ci.sh | sh + - ros install prove + +before_script: + - ros --version + - ros config + - ros -e '(princ (lisp-implementation-type)) + (terpri) + (princ (lisp-implementation-version)) + (terpri) + (princ *features*) + (terpri) + (uiop:quit 0)' + +script: + - run-prove cl-info-test.asd diff --git a/ChangeLog.rst b/ChangeLog.rst new file mode 100644 index 0000000..40220bc --- /dev/null +++ b/ChangeLog.rst @@ -0,0 +1,13 @@ +=========== + ChangeLog +=========== + +0.1.0 (unreleased) +================== + +* Number features here. +* Like that. +* Add new versions to the top. +* Specify dates as ``2017-04-19``. +* Read `KeepAChangelog.com `_ for futher + explanations. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..d3a362a --- /dev/null +++ b/README.rst @@ -0,0 +1,80 @@ +================= + cl-info +================= + +.. insert-your badges like that: + +.. image:: https://travis-ci.org/40ants/cl-hamcrest.svg?branch=master + :target: https://travis-ci.org/40ants/cl-hamcrest + +.. Everything starting from this commit will be inserted into the + index page of the HTML documentation. +.. include-from + +Give some introduction. + +Reasoning +========= + +Explain why this project so outstanding and why it +was created. + +You can give some examples. This is how common lisp +code should be formatted: + +.. code-block:: common-lisp + + (defvar log-item '(:|@message| "Some" + :|@timestamp| 122434342 + ;; this field is wrong and + ;; shouldn't be here + :|@fields| nil)) + +And this is how you can provide REPL examples: + +.. code-block:: common-lisp-repl + + TEST> (format nil "Blah minor: ~a" + 100500) + "Blah minor: 100500" + +Roadmap +======= + +Provide a Roadmap. + +.. Everything after this comment will be omitted from HTML docs. +.. include-to + +Building Documentation +====================== + +Provide instruction how to build or use your library. + +How to build documentation +-------------------------- + +To build documentation, you need a Sphinx. It is +documentaion building tool written in Python. + +To install it, you need a virtualenv. Read +this instructions +`how to install it +`_. + +Also, you'll need a `cl-launch `_. +It is used by documentation tool to run a script which extracts +documentation strings from lisp systems. + +Run these commands to build documentation:: + + virtualenv env + source env/bin/activate + pip install -r docs/requirements.txt + invoke build_docs + +These commands will create a virtual environment and +install some python libraries there. Command ``invoke build_docs`` +will build documentation and upload it to the GitHub, by replacing +the content of the ``gh-pages`` branch. + diff --git a/cl-info-test.asd b/cl-info-test.asd new file mode 100644 index 0000000..b2a0174 --- /dev/null +++ b/cl-info-test.asd @@ -0,0 +1,16 @@ +#| + This file is a part of cl-info project. +|# + +(defsystem cl-info-test + :author "" + :license "" + :class :package-inferred-system + :pathname "t" + :depends-on (:cl-info + "cl-info-test/core") + :description "Test system for cl-info" + + :perform (test-op :after (op c) + (symbol-call :rove :run c) + (clear-system c))) diff --git a/cl-info.asd b/cl-info.asd new file mode 100644 index 0000000..d8c01eb --- /dev/null +++ b/cl-info.asd @@ -0,0 +1,29 @@ +#| + This file is a part of cl-info project. +|# + + +(defsystem cl-info + :version (:read-file-form "version.lisp-expr") + :author "" + :license "" + :class :package-inferred-system + :pathname "src" + :depends-on ( + "cl-info/core") + :description "" + :long-description + #.(with-open-file (stream (merge-pathnames + #p"README.rst" + (or *load-pathname* *compile-file-pathname*)) + :if-does-not-exist nil + :direction :input) + (when stream + (let ((seq (make-array (file-length stream) + :element-type 'character + :fill-pointer t))) + (setf (fill-pointer seq) + (read-sequence seq stream)) + seq))) + :in-order-to ((test-op (test-op cl-info-test)))) + diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..332cc8b --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,153 @@ +# 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 new file mode 100644 index 0000000..ebbb6a1 --- /dev/null +++ b/docs/requirements.in @@ -0,0 +1,10 @@ +# 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 new file mode 100644 index 0000000..06f074b --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,30 @@ +# +# 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 new file mode 100644 index 0000000..e69de29 diff --git a/docs/source/api.rst b/docs/source/api.rst new file mode 100644 index 0000000..ceeb5a2 --- /dev/null +++ b/docs/source/api.rst @@ -0,0 +1,30 @@ +===== + 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 new file mode 100644 index 0000000..705b295 --- /dev/null +++ b/docs/source/changelog.rst @@ -0,0 +1 @@ +.. include:: ../../ChangeLog.rst diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..e94b28f --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,324 @@ +# -*- 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 new file mode 100644 index 0000000..e7865df --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,40 @@ +========================================= + 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/roswell/cl-info b/roswell/cl-info new file mode 100755 index 0000000..dbc3d08 Binary files /dev/null and b/roswell/cl-info differ diff --git a/roswell/cl-info.ros b/roswell/cl-info.ros new file mode 100755 index 0000000..b065fb2 --- /dev/null +++ b/roswell/cl-info.ros @@ -0,0 +1,38 @@ +#!/bin/sh +#|-*- mode:lisp -*-|# +#| +exec ros -Q -- $0 "$@" +|# +(progn ;;init forms + (ros:ensure-asdf) + #+quicklisp (ql:quickload '(cl-info + defmain) + :silent t)) + +(defpackage :ros.script.cl-info + (:use :cl) + (:import-from #:cl-info/core + #:make-cl-info + #:make-system-info) + (:import-from #:defmain + #:defmain)) +(in-package :ros.script.cl-info) + + +(defmain main ((version "Show program version and exit." + :flag t) + &rest system) + "Show information about Lisp implementation and given systems. Useful when collecting information for bugreports." + + (when version + (let* ((system (asdf:find-system :cl-info)) + (version (asdf:component-version system))) + (format t "Version: ~A~%" version) + (uiop:quit 0))) + + (princ (make-cl-info)) + + (loop for system-name in system + do (princ (make-system-info system-name)))) + +;;; vim: set ft=lisp lisp: diff --git a/src/core.lisp b/src/core.lisp new file mode 100644 index 0000000..f130d36 --- /dev/null +++ b/src/core.lisp @@ -0,0 +1,100 @@ +(defpackage #:cl-info/core + (:nicknames #:cl-info) + (:use #:cl) + (:export + #:cl-info + #:get-asdf-version + #:get-lisp-type + #:get-lisp-version + #:get-software-type + #:get-software-version + #:get-ql-dists + #:make-cl-info + #:system-info + #:get-name + #:get-version + #:get-path + #:absent-p + #:make-system-info)) +(in-package cl-info/core) + + +(defclass cl-info () + ((asdf-version :initform (asdf:asdf-version) + :reader get-asdf-version) + (lisp-type :initform (lisp-implementation-type) + :reader get-lisp-type) + (lisp-version :initform (lisp-implementation-version) + :reader get-lisp-version) + (software-type :initform (software-type) + :reader get-software-type) + (software-version :initform (software-version) + :reader get-software-version) + (ql-dists :initform (ql-dist:all-dists) + :reader get-ql-dists))) + + +(defclass system-info () + ((name :initarg :name + :reader get-name) + (version :initarg :version + :reader get-version) + (path :initarg :path + :reader get-path) + (absent :initarg :absent + :initform nil + :reader absent-p))) + + +(defmethod print-object ((info cl-info) stream) + (format stream + "OS: ~A ~A +Lisp: ~A ~A +ASDF: ~A +QL: ~{~A~^~%~} +" + (get-software-type info) + (get-software-version info) + (get-lisp-type info) + (get-lisp-version info) + (get-asdf-version info) + (loop for dist in (get-ql-dists info) + for idx upfrom 0 + collect (format nil "~:[~; ~]~A ~A" + (> idx 0) + (ql-dist:name dist) + (ql-dist:version dist))))) + + +(defmethod print-object ((info system-info) stream) + (if (absent-p info) + (format stream + "System: ~A is not available" + (get-name info)) + (format stream + "System: ~A ~A + ~A +" + (get-name info) + (get-version info) + (get-path info)))) + + +(defun make-cl-info () + (make-instance 'cl-info)) + + +(defun make-system-info (system-name) + (let ((system (asdf:find-system system-name))) + (if system + (make-instance 'system-info + :name system-name + :version (asdf:component-version system) + :path (asdf:component-pathname system)) + (make-instance 'system-info + :name system-name + :absent-p t + :version nil + :path nil)))) + + diff --git a/t/core.lisp b/t/core.lisp new file mode 100644 index 0000000..557a9bb --- /dev/null +++ b/t/core.lisp @@ -0,0 +1,12 @@ +(defpackage #:cl-info-test/core + (:use #:cl + #:cl-info/core + #:rove + #:hamcrest/rove)) +(in-package cl-info-test/core) + + +(deftest test-some-staff + (testing "Replace this test with real staff." + (assert-that (foo 1 2) + (contains 1 2)))) diff --git a/tasks.py b/tasks.py new file mode 100644 index 0000000..7ddd766 --- /dev/null +++ b/tasks.py @@ -0,0 +1,42 @@ +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) diff --git a/version.lisp-expr b/version.lisp-expr new file mode 100644 index 0000000..a8e9604 --- /dev/null +++ b/version.lisp-expr @@ -0,0 +1 @@ +"0.1.0" \ No newline at end of file