PyPI 官网下载 | remark-1.6.5.tar.gz

Release history =============== [[Parent]]: remark.txt This section summarizes the release history of Remark. Previous versions can be obtained through the given links. The versioning of Remark is given in the form x.y.z, where x, y, and z are integers. The x increments only for major changes, the y increments for feature changes, and the z increments for bug fixes or documentation updates. Whenever y is incremented, z is zeroed, and whenever x is incremented, both y and z are zeroed. The x, y, and z need not consist of a single digit, and, for example, 1.12.0 is a much later version than 1.1.3. Remark 1.6.5 ------------ Release date 14.12.2014. [Original webpage][Remark-1.6.5] [Remark-1.6.5]: http://kaba.hilvi.org/remark-1.6.5 ### CSS * Changed to use the Open Sans font for prose. * Changed to use the Inconsolata font for code, or Consolas if available (Windows). ### Example macro * Wrapped the produced content in a div. * Separated the example from its surrounding by drawing a box around it. * Removed the preceding and following texts. ### SourceChildren macro * The title is now created only if it is non-empty. ### Documentation * Changed to use the improved Example macro. Remark 1.6.4 ------------ Release date 13.12.2014. [Original webpage][Remark-1.6.4] [Remark-1.6.4]: http://kaba.hilvi.org/remark-1.6.4 ### Core * Added a viewport meta-tag so that html works nicely with tablets and phones. ### CSS * Made CSS work nicely with tablets and phones. * Changed to use flexboxes. * Made list-based links block-based, for increased area. ### SourceChildren * Made to output a list of links instead of sequential links. * Added a div for CSS-styling. Remark 1.6.3 ------------ Release date 4.12.2014. [Original webpage][Remark-1.6.3] [Remark-1.6.3]: http://kaba.hilvi.org/remark-1.6.3 ### Packaging * Changed Markdown requirement from 2.0.0 to 2.0. Remark 1.6.2 ------------ Release date 23.11.2014. [Original webpage][Remark-1.6.2] [Remark-1.6.2]: http://kaba.hilvi.org/remark-1.6.2 ### Macros * Code: Fixed a crash when the lexer could not be guessed from content. Remark 1.6.1 ------------ Release date 18.04.2014. [Original webpage][Remark-1.6.1] [Remark-1.6.1]: http://kaba.hilvi.org/remark-1.6.1 ### Interface * Made minor improvements to output reporting. ### Style * Made tables pretty when using the default CSS style. * Made some minor tweaks to the default CSS style. ### Macros * DocChildren: Grouped undescribed files in the same description-group. * DocChildren: Fixed a bug which gave a bad-looking grouping in some cases. * Code: Forced `.m` files to be identified as Matlab files when the type is not explicitly specified. ### Packaging * Changed to use Setuptools, instead of Distribute. Remark 1.6.0 ------------ Release date 28.05.2013. [Original webpage][Remark-1.6.0] [Remark-1.6.0]: http://kaba.hilvi.org/remark-1.6.0 ### Breaking changes * Changed the command-line file inclusion to work by relative-paths of files, rather than by filenames. This breaks the inclusion of multiple files with the same filename, but in different directories; the old behavior can be recovered by changing `"filename.txt"` to `"*filename.txt"`. * Changed the location of the Remark command-line script from the `Remark` directory to the Remark root directory. This had to be done so that `pip` packaging works correctly. However, this is also a more natural location for the command-line script. ### Interface * Added the option `-x` to exclude files by their relative-paths. This helps in skipping build-files and other inessential files in a typical build-environment. * Added the option `-i` to include files by their relative-paths. This is the same as simply listing them; this option is for symmetry with the option `-x`. * Added the option `-o` to read command-line options from an option-file (if the file exists). The `remark_options` is implicitly included as an option-file. * Added the option `-u` to list all those files in the input directory which are neither included or excluded (called unknown files). This helps to check whether one has remembered to include all essential files into the documentation. * Increased the default maximum number of lines for the tag-parsers from 100 to 200. In Matlab, the tags must be placed at the end of this function documentation to not interfere with the built-in help system. My own Matlab function documentation exceeded 100 lines, one being 135 lines. ### Variables * Added the `remark_version` as a predefined variable, to aid in the documentation of Remark itself. ### Macros * Added the ReadFile macro, to read plain-text files. This generalizes the Body macro. * Added the `type` variable in the Code macro so that the type of the code can be specified explicitly. * Made description grouping more effective in the SourceChildren macro. ### Style * Restyled the default CSS file. ### Packaging * Added a repository for Remark on BitBucket. * Added an issue tracker for Remark on BitBucket. * Made Remark installable from PyPI using `pip` and `easy_install`. * Changed to use Pillow instead of PIL. Remark 1.5.1 ------------ Release date 31.10.2012 [Original webpage][Remark-1.5.1] [Remark-1.5.1]: http://kaba.hilvi.org/remark-1.5.1 ### Core * Added a check for Python Markdown version 2.0, to prevent using Remark with versions of Python Markdown (e.g. 2.2) that do not support Markdown in html blocks. * Fixed a regex-formation bug in `Dictionary_TagParser`, which caused the `Author` and `DocumentationOf` tags to not being parsed. ### Macros * Gallery: Made the PIL import work also in the case where PIL is installed in a directory named something else than PIL, as is the case when installing PIL via `easy_install` (bug credit: Germán Gómez-Herrero). ### Others * Set the correct release date for Remark 1.5.0 in release history. * Rewrote the installation documentation. Remark 1.5.0 ------------ Release date 30.09.2012 [Original webpage][Remark-1.5.0] [Remark-1.5.0]: http://kaba.hilvi.org/remark-1.5.0 ### Acknowledgements * Germán Gómez-Herrero did extensive testing on Remark 1.5.0, and came up with ideas for the ParentList and DocumentTree macros, and support for long-UNC paths under Windows. ### Core * Added support for long-UNC-paths under Windows. * Added document-tags. * Added a reporting system for more accurate error messages and the ability to disable specific messages. * Generalized indentation as a specific way to invoke a macro, and made this macro selectable at runtime by the `indent` variable. * Made Remark to copy a file only when the target file does not exist _or_ the source file has been modified after the target file. * Made Remark name links to code-files with their filenames, rather than with their descriptions. * Escaped Markdown meta-characters in path-based link-descriptions (e.g. \_\_init\_\_.py instead of __init__.py). * Fixed a crash in the handling of invalid utf-8 files by replacing invalid parts with the U+FFFD REPLACEMENT CHARACTER symbol. * Removed predefined variables, and replaced them with document tags. * Removed get-command. ### Interface * Changed it so that all converted files need to be listed, rather than just those which are to be copied. * Added an option for listing all the file-extensions in the input directory along with example files. This makes it easier to check that one has remembered to include all necessary files. * Added an option for generating only the modified files and their parents for quick previews. * Added an option for verbose mode, and moved successful output from the normal mode to the verbose mode. This makes it easier to spot warnings.