File elixir-ex_doc.changes of Package elixir-ex_doc
-------------------------------------------------------------------
Mon Nov 20 11:56:05 UTC 2023 - matwey.kornilov@gmail.com
- Update to version v0.30.9:
* Release v0.30.9
* Revert "Safety check before running File.rm_rf! in doc gen (#1707)"
* Update assets
* Admonition EPUB styles (#1793)
* Release v0.30.8
* Fix docs generation with multiple source beams
* Release v0.30.7
* Change text decoration color on cheatsheet headers
* Partially fix abstract Erlang types (`{@type ...}`) (#1787)
* Use pattern matching on underscored functions, closes #1784
* Autolink support for handling remote types in records (#1763)
* Use backticks consistently in `mix docs` docs (#1783)
* Support any String.Chars.t on extras
* Fix errors on search page
* Reuse .build instead of adding a new file
* Update assets
* Scroll to top on iOS (#1777)
* Update assets
* Fix sidebar overflow-y behavior (#1776)
* Update assets
* improvement: add `type` field to the docs for reference in search
* Fix tabpanel role invalid on a list element (#1770)
* Update assets
* Improve screen reader accessibility (#1760)
* Remove links from module page “hover link” headings in EPUB (#1768)
* Update assets
* Fix invalid output markup for “hover link” headings which contain their own links (#1767)
* Warn if typespec references filtered module (#1761)
* Add skip_code_autolink_to option (#1759)
* Release v0.30.6
* Extract title even with comments
* Update assets
* Make checked switch button focus state visible
* Show function header link when focused
* Update assets
* Remove unecessary css
* Fix view links on cheatsheets
* Update assets
* Add text decoration to admonition
* Revert "Revert hover link approach to fix markup of headings containing links (#1752)"
* Keep cheatsheet h3 color
* Update assets
* Revert hover link approach to fix markup of headings containing links (#1752)
* Fixing 2 columns and align bugs in Safari (#1751)
* Add link headings to epub
* Update assets
* Comment focus approach
* Refactor repeating sidebar font-sizes to vars
* Make it possibe to focus expand links in sidebar
* Make search button fully visible on focus
* Make copy button more visibel over text
* Add universal focus styles for all focusable elements
* Refactor sidebar to use vars for repeating values
* Don't allow focusing inside invisible sidebar
* Make it possible to focus code copy buttons
* Update assets
* Remove sidebar gradient (#1748)
* Release v0.30.5
* Do not style headers as links
* Fix generating search_data.json for undocumented Erlang functions
* Release v0.30.4
* Bump word-wrap from 1.2.3 to 1.2.4 in /assets (#1742)
* Update assets
* fix generation of livebook paths to handle omitted '.html' correctly (#1741)
* Update assets
* Release v0.30.3 with latest assets
* Remove (out of date) Node version from main readme (#1738)
* Update assets stated Node version requirements to 18, to match CI (#1737)
* Update assets
* JS lint
* Add pending files
* Compress and decompress search index (#1735)
* Release v0.30.2
* Ignore vegalite codeblocks in search (#1736)
* Avoid interpolation
* Cover additional escape sequences
* Release v0.30.1
* Update assets
* Fix bugs in headers
* Release v0.30.0
* Update assets
* Revert "Make dummy assets change"
* Update assets
* Make dummy assets change
* Update assets on CI (#1731)
* Remove padding on anchor
* Rebuild assets
* Rename `searchNodes` to `searchData` (#1729)
* Fix escaping `#{}` in search_items.json (#1728)
* Update EarmarkParser
* Properly provide for admonition code colours across themes (#1727)
* Fix title for Mix tasks in search_items.json (#1725)
* mermaid.js proper async processing (#1724)
* mermaid.js to 10.2.3 (async invocation) and make it respect color theme (#1723)
* Warn on invalid references in links (#1722)
* Move sectionize to DocAST module
* Keep only strike-through on autocomplete
* Distinct deprecated autocomplete suggestions (#1716)
* Improve docs for sectionize
* Add source URL link to API reference page (#1717)
* Create .exdoc file after warning about using an existing directory (#1713)
* Fix h3 with links in admonition, closes #1715
* Hide anchor inside blockquote, closes #1714
* Safety check before running File.rm_rf! in doc gen (#1707)
* Commit the actual changes from previous commit
* Update examples
* Fixes to headings with code in them
* Refctor ExDoc.Language.ElixirTest
* Simplify
* Do not log error on case-insensitive file systems
* Bump socket.io-parser from 4.2.1 to 4.2.3 in /assets (#1711)
* Change search_items.json section titles to `<header> - <title>`
* Add module and function sections to search_index.json (#1710)
* Change ExDoc.Language.ElixirTest to async: false
* Allow multiple extra files with the same name (#1708)
* Add doc markdown to search_items.json (#1705)
* Make ExDoc.Language.ErlangTest more robust
* Fix tests on OTP 26 (#1706)
* Start edoc & xmerl when running tests (#1704)
* Skip ExDoc.DocAST and ExDoc.Language.ast_spec() warnings
* mix build
* Add `cursor: pointer` to tabs (#1702)
* Tidy up tabsets JavaScript (#1701)
* Improve sidebar search placeholder text hue (#1700)
* Add support for tabsets (#1699)
* mix format
* Keep HTML comments in generated HTML
* Weaken tone of content links to improve legibility of link text (#1697)
* Reinstate heavier font-weight for sidebar list items for non-Apple (#1696)
* Fix sidebar button background gradient color (#1695)
* Tweak readme (#1694)
* Bump engine.io and socket.io in /assets (#1698)
* Make ExDoc CLI strict
* Fix text overflow ellipses in sidebar (#1692)
* Introduce borderRadius CSS variable (#1691)
* Update Ubuntu (#1690)
* Update the README - bump KaTeX version from 0.13.19 to 0.16.4, and update KaTeX config (#1687)
* Skip if abstract code is missing, closes #1689
* Initialize toast when document is loaded
* Bug fix: properly show the modules in the left pane when using external libraries (such as KaTeX) (#1686)
* Update assets
* Also fix version dropdown
* Release v0.29.4
* Layout on apple-os and sidebar
* Display tooltip content as html (#1685)
* Release v0.29.3
* Fix settings icon position (#1683)
* Keep language class on livebook output code block (#1682)
* Propagate :since metadata from modules (#1680)
* Fix precedence of switches vs config (#1679)
* Improve consistency of type rendering weight across OSes (#1677)
* feat: add before_closing_body_tag map support (#1676)
* Simplify docs
* Add before_closing_body_tag mfa support (#1670)
* Make sidebar CSS use semantic vars (#1674)
* Update Earmark (#1671)
* Fix copy icon spacing
* Release v0.29.2
* Increase contrast on sidebar
* Fix visited link color in admonition blocks (#1666)
* Update Cheatsheet print styles (#1665)
* Don't attempt parsing code blocks that don't look like modules (#1662)
* Do not use tests that modify app env concurrently
* Remove superfluous import of common custom properties from Erlang CSS (#1660)
* Fix extra spacing on pages with no sections
* Tweak cheatsheet CSS (#1658)
* Update print page break-related declarations (#1657)
* Bump ua-parser-js from 0.7.32 to 0.7.33 in /assets (#1655)
* Prevent h3 horizontal rule causing horizontal page overflow/scrollbar (#1654)
* Fix clickable area of sidebar tabs (#1653)
* Make sidebar links full-width and add hover states
* Add test for section suggestions
* Include sections of modules and extras in search suggestions
* Focus search input immediately after keyboard shortcut
* Prevent content-inner overflow (unwanted horizontal scrolling) (#1650)
* Return true instead of undefined in assets utility run cmd function (#1651)
* Fix slight horizontal scrolling on small screens (#1647)
* Build assets
* Use more horizontal space on smaller screens (#1643)
* Tweak CSS for consistency (#1645)
* Update assets npm packages (#1646)
* Bump json5 from 1.0.1 to 1.0.2 in /assets (#1644)
* Add media type for .license files for epub (#1642)
* Revert "Change format for tooltip header (#1640)" (#1641)
* Change format for tooltip header (#1640)
* Tighten up cheatsheet spacing on small screens and fix h3 line wrapping (#1638)
* Contain overscroll on the sidebar
* README updates: grammar, style, example clarity, capitalisation (#1633)
* Update assets npm packages (all MINOR and PATCH) (#1634)
* Add watch mode to asset build process (#1632)
* Bump engine.io from 6.2.0 to 6.2.1 in /assets (#1631)
* Release v0.29.1
* Rename groups_for_functions as groups_for_docs
* Add optional function annotations (#1627)
* Firefox H2 print rendering fix (#1630)
* mix format
* Consistenly use __doc__ for metadata
* Rename internal nodes for consistency
* Simplify handling of empty nodes in module summary
* Use v1.13 formatting rules
* mix format
* Add print and download epub links
* Basic Cheatsheet print.css (#1629)
* Initial pass at improving print.css (#1628)
* sidebar_template.eex: Disable spellcheck and autocorrect on search input (#1626)
* Remove Coveralls leftovers (#1625)
* Add exception for functions called record/* (#1576)
* Add tooltip to functions on sidebar (#1624)
* Support Erlang Extras (#1617)
* Adds a missing verb to README (#1622)
* Update examples
* More docs
* mix format on earlier Elixir versions
* Release v0.29.0
* Last cheatsheet adjustments
* fixed query for lists and col-left
* Add ol examples and breakpoints (#1620)
* Save sidebar state per session (#1619)
* Updates to cheatsheet
* Revert "Save sidebar state per session (#1606)"
* Cheatsheet adjustments
* Cheatsheets markup (#1618)
* Release v0.28.6
* Remove unused docs_from_files
* Fix broken types and some dialyzer issues (#1615)
* Add fonts
* Add classes to sectionize
* Add night version of the output scrollbar (#1613)
* Add scrollbar to large output code blocks (#1612)
* Distinguish output code blocks (#1611)
* Readable yellow color for Dark mod (#1609)
* Static hosting of google fonts (#1608)
* Save sidebar state per session (#1606)
* Move to esbuild and update npm packages (#1605)
* fix: prevent unreadable text when using inline code with admonition headers (#1603)
* Prepare CSS for esbuild (#1602)
* Fix tests (#1601)
* Add Elixir special punctuation ! and ? to natural sort (#1574)
* Adjust quick switch in night mode (#1600)
* Support --proglang in mix docs
* Bump nth-check and optimize-css-assets-webpack-plugin in /assets (#1598)
* Bump glob-parent from 3.1.0 to 5.1.2 in /assets (#1599)
* Remove Less CSS (#1597)
* Prevent sidebar button scrolling out of view (#1596)
* Match case
* Fix CI
* Add class to body based on the page type
* Add a sample cheatsheet
* Add unit tests to sectionize
* Add cheatmd support (#1595)
* Fix tests on Elixir v1.15-dev
* Add night mode to settings pane
* Move toggle item out of sidebar to address iOS Safari bug
* Release v0.28.5
* Remove line from every signature meta (#1592)
* fix: remove extra term() argument at start of macrocallback spec (#1590)
* Refactor indexing logic
* Index hyphens (#1589)
* Improve admonition block example (#1580)
* Custom trimmer to index `@` (#1581)
* Fix loading serialized index from sessionStorage (#1579)
* Improvements to dark mode
* Avoid race conditions in tests (#1569)
* Change minimal package search length to 2 (#1567)
* Sort alphabetically (#1565)
* Release v0.28.4
* Automatically convert .livemd links
* Remove race in tests
* Simplify title extraction, closes #1563
* Escape &%/2 special form (#1562)
* Use tmp_dir in template tests (#1561)
* Optimize html/epub tests by making them asyncronous by using tmp_dir tag (#1557)
* Show programming language in HTML footer (#1560)
* Mention how to extend syntax highlighting in the README
* Add tests for license files and all files in .build (#1556)
* Include Javascript Script libraries in doc build (#1553)
* Add toast when changing theme via keyboard (#1547)
* Update npm lock file
* Include makeup_html on bin path, closes #1539
* Release v0.28.3
* Include page titles in autocomplete (#1537)
* Update assets, highlight html
* Change from nightMode to theme (#1532)
* Bump karma from 6.3.14 to 6.3.16 in /assets (#1526)
* Remove "Specs" heading and render full typespecs (#1455)
* Simplify tests
* support for `source_url_pattern` in config being a function (#1529)
* Fix sorting when a list of dirs is provided (#1530)
* Fix css in blockquote, closes #1528
* Remove unused alias
* Unify some functionality around ExDoc.Utils
* Sort items "naturally" in menu, summary, function list, etc. (#1524)
* Adjust admonition block for dark mode (Fixes: #1522) (#1523)
* Release v0.28.2
* Fix links in blockquote
* Fix code tags inside admonotion blocks in dark mode, closes #1519
* Release v0.28.1 with fixed assets
* Remove italic from block quotes
* Release v0.28.1
* Release v0.28.1
* Add macro example to the retriever test
* add support for admonition text blocks (#1400)
* Bump ws from 6.2.1 to 6.2.2 in /assets (#1512)
* Bump dot-prop from 4.2.0 to 4.2.1 in /assets (#1511)
* Bump tar from 4.4.13 to 4.4.19 in /assets (#1510)
* Bump ajv from 6.5.3 to 6.12.6 in /assets (#1509)
* Add tokenizer to search pipeline (#1517)
* Add `:otp_eep48` and `:otp_has_docs` tags (#1516)
* Use `:tmp_dir` tag
* Add `ExDoc.Formatter.HTML.ErlangTest` (#1514)
* Update deps
* Bump karma from 3.1.4 to 6.3.14 in /assets (#1508)
* Skip heisentest on earlier OTP versions
* Fix elixir ref
* Read types if possible
* Do not warn if types are missing
* Fix module hint heading extraction (#1507)
* Dont navigate when clicking the current page
* Accessibility - general improvement (#1505)
* Fix grammar in the settings modal (#1503)
* Fix typos (#1502)
* Another attempt at fixing `mix docs --open` on Windows
* Fix `mix docs --open` on Windows (#1501)
* Update changelog link (#1499)
* Release v0.28.0
* Tasks must have higher preference than behaviours
* Require Elixir v1.11+
* Only copy selectable content, closes #1496
* Add missing margin for headers (#1494)
* Add `--open` flag (#1493)
* Update list of maintainers
* Clarify use of :
* Fix header on search page
* Bump follow-redirects from 1.11.0 to 1.14.7 in /assets (#1489)
* Mark width for both header and input, closes #1486
* Keep hamburger absolute to opened sidebar, closes #1482
* Add custom scrollbar for sidebar (#1481)
* Use --cd instead of --prefix for Windows
* Link to the configured page, closes #1485
* Make sure titles are generated
* Release v0.27.3
* Slightly lower contrast of headings in night mode (#1479)
* 2021 -> 2022 for latest changes (#1477)
* Add case insensitive quick switch search match (#1475)
* Keep only necessary transitions
* Improve sidebar open/close animation
* Keep settings and module source on top if possible
* Release v0.27.2
* Several fixes:
* Release v0.27.1
* Several fixes
* Add settings button to all pages (#1473)
* Update modal and settings styles for small viewport (#1472)
* Updates to README
* Keep order on pages, closes #1469
* Small icon adjustments
* Release v0.27.0
* Fixes for HexDocs modal
* Remove repeated nesting modules
* Fix search
* Settings - better layout using tabs (#1468)
* Fix navigation (#1467)
* Enable field search
* Update mix.exs
* Revert "Remove nesting from ExDoc"
* Improve contrast
* Update CHANGELOG
* Fix long titles (#1464)
* Blink with gray instead of yellow in dark mode (#1463)
* Update assets and yellows
* New icons (#1462)
* Remove display keyboard shorcuts from footer
* Unified settings (#1460)
* New Navigation (#1461)
* Sort Task's options alphabetically
* Update earmark_parser
* Fix epub check on CI
* More space on modal
* Only generate HexDocs search if a package
* Small fixes (#1457)
* Several ExDoc fixes
* Redesign sidebar (#1456)
* Document `--proglang` switch
* Remove nesting from ExDoc
* Run on Elixir v1.13
* Implement focus trapping on modals (#1454)
* Format
* Simplify --quiet tests
* Add --quiet switch to ExDoc.CLI (#1449)
* Run formatter
* Use a more robust check for function
* Add multiple formatters to ex_doc CLI
* Use config.proglang in epub head template (#1447)
* Use Struct instead of __struct__/0 in sidebar (#1446)
* Add support for themed img (#1445)
* Fix minor typo in README.md (#1444)
* Warning on dependencies (#1442)
* Fix JS lint
* Only add copy button if there is a code tag inside
* Update deps
* Render docs in parallel
* CI: Update to "main" brach
* Fix copy button in night mode (#1439)
* Add translate no to code snippet to address nl to ws conversion
* Remove exceptions from epub
* Point to www.erlang.org, closes #1431
* Release v0.26.0
* Add translate="no" tags throughout the project
* Update assets
* Document how to render Mermaid graphs (#1435)
* Update README.md
* Add a section on metadata
* Add optional module annotations (#1430)
* Introduce settings modal (#1429)
* Bump elliptic from 6.5.2 to 6.5.4 in /assets (#1427)
* Bump y18n from 4.0.0 to 4.0.3 in /assets (#1426)
* Run formatter
* Bump lodash from 4.17.11 to 4.17.21 in /assets (#1425)
* Bump handlebars from 4.7.6 to 4.7.7 in /assets (#1424)
* Bump hosted-git-info from 2.8.8 to 2.8.9 in /assets (#1423)
* Bump ssri from 6.0.1 to 6.0.2 in /assets (#1422)
* Bump path-parse from 1.0.5 to 1.0.7 in /assets (#1421)
* Bump color-string from 1.5.3 to 1.6.0 in /assets (#1420)
* Update CHANGELOG
* Default branch is now main
* Rename filter_prefix to filter_modules
* Unify grouping functionality
* Document how to render Vega-Lite plots (#1417)
* Removed smartypants option alltogether (#1416)
* Do not warn on links to sections
* Add instructions for rendering math with KaTeX (#1414)
* Run linter
* Only add buttons if clipboard is enabled
* Add copy button
* Release v0.25.5
* Update assets
* Fix duplicated API Reference heading (#1410)
* Release v0.25.4
* Localize fixtures
* Improve coverage
* Update CHANGELOG
* Add source link and Livebook badge to extras (#1408)
* Remove unused --source-root option
* mix format
* Do not generate entries for private functions
* Tokenize function names on search (#1399)
* Do not check :private on visibility in ExDoc.Language.Erlang.do_url (#1398)
* Release v0.25.3
* Do not escape functions
* Handle cover-compiled modules, closes #1395
* Do not double escape sidebar items
* Only skip :hidden entries, closes #1393
* Update README.md
* fix(sidebar): track user pref for sidebar state (#1394)
* Run formatter (#1392)
* Fix typo in SIDEBAR types (#1390)
* Don't crash upon doc chunks for unknown beam languages (#1389)
* Remove unused deps
* Release v0.25.2
* Preload makeup plugins
* Remove OTP 23 from CI
* Assume OTP 24+ for edoc chunk tests
* Skip modules that have chunk but are not loaded
* Fix handling typespecs with the same name as the type
* Include kind in undefined reference warning
* Add a temporary way to disable warnings on unsupported `<see*>` links
* Handle erts typespecs
* Handle OTP links when generating OTP docs
* Add test
* Fix URLs in CLI usage (#1387)
* Add TODO
* Rename :docs_chunk -> :docs
* Handle fragments
* Allow linking to private types in specs
* Handle app references
* Refactor app and tool lookup
* Remove TODO, we're fixing it upstream
* Add support for Livebook's `.livemd` Markdown files (#1386)
* Rebuild assets
* Add Hex package config and display "Find on Hex" footer links (#1385)
* More Erlang spec autolinking fixes
* Release v0.25.1
* mix docs: Use shell lexer for code blocks with "$ " and no language
* TestHelper.erlc: return errors
* Fix accidentally showing opaque shape
* Move optional callbacks to language
* Skip Erlang functions that have empty docs (#1384)
* Skip Erlang modules that have empty docs (#1383)
* Simplify skipping modules
* Make language-specific private data explicit
* Test on OTP 24 (#1382)
* Remove TODO
* Standardise tests
* Uncomment test
* Break up retriever test
* Merge module_data and module_state
* Move abstract code retrieval to language
* Remove HTML.link_id/1..2 (2nd attempt)
* Revert "Remove HTML.link_id/1..2"
* Remove HTML.link_id/1..2
* Group callbacks, ref: #1160
* Move nesting info to the language
* Fix generating type signatures with maps
* Remove not relevant TODOs
* Release v0.25.0
* Support `console` name in the shell lexer
* Remove function landing pages
* Add simple shell lexer (#1380)
* Simplify retrieving line and signature
* Change type_data/2 to take module_state
* module_data -> module_state
* Update "Using ExDoc with Erlang projects" guide (#1379)
* escript: Rename --prepend-path to --paths, support globs and multiple uses
* Add "Using ExDoc with Erlang projects" to README (#1378)
* ExDoc.Language.Erlang: Autolink typespecs (#1376)
* ExDoc.Autolink: default :file to "nofile"
* ExDoc.Language.Erlang: Start testing autolink_spec/2
* Update erlc to generate docs chunks by default
* ExDoc.DocAST: Turn `<pre>` into `<pre><code>` for erlang+html
* ExDoc.Language: Add highlight_info/0 callback
* ExDoc.Autolink.Erlang: Warn on unsupported application refs
* ExDoc.Autolink.Erlang: warn on bad remote refs
* ExDoc.Autolink.Erlang: warn on bad local refs
* ExDoc.Autolink.Erlang: warn on bad module refs
* ExDoc.Autolink: Add maybe_warn/4
* ExDoc.CLI: Add tests for --config .config
* ExDoc.CLI: Support docs.config
* ExDoc.Language.Erlang: support external refs
* ExDoc.CLI: Add --prepend-path, closes #1371
* Initial support for autolinking Erlang docs
* Start moving code back to Autolink
* walk -> walk_doc
* Prepare for autolinking Erlang docs
* Add ExDoc.Language.autolink_doc/2 and autolink_spec/2 callbacks
* Fix proglang switch type
* Bump version to -dev
* Normalize proglang (#1367)
* Support Markdown Processor Options (#1365)
* Add language contract (#1362)
* Handle remote types in signatures (#1364)
* Update CI config
* Add missing impl true
* Merge Highlighter into DocAST
* Add ellipsis to more sections (#1361)
* Normalize trailing slash for paths, closes #1359
* Add data-nosnippet to disclaimer message
* Deal with custom link that links to undefined/hidden module (#1349)
* Rename doc variables (#1353)
* Release v0.24.2
* Generating void elements correctly on `DocAST.to_string` (#1351)
* Fix bug defining app name in config (#1347)
* Support stepped range syntax (#1346)
* Add spaces on paragraph endings for search results (#1167)
* Release v0.24.1
* Add test
* Fix function entry page name check, closes #1344
* Release v0.24.0
* Hide --proglang for now
* Update CHANGELOG.md
* Handle non-letter character when generating function landing pages
* Update assets
* Add function landing page (#1342)
* chore: fix missing HTTPS on links (#1337)
* Remove unneeded whitespace (#1338)
* Update CI config (#1336)
* Move text overflow to a to avoid false positives
* Update erlang.org/man URL (#1335)
* Add --proglang flag (#1331)
* Bump version
* Test fetching Erlang types
* Test fetching Erlang callbacks
* Use signature from chunk for types (#1330)
* Refactor fetching callbacks (#1329)
* Minor compatibility fixes
* Don't raise when module has no docs chunks (#1328)
* Remove outdated version check (#1327)
* Start supporting Erlang (#1326)
* Minor changes to retriever tests
* Rewrite retriever tests to not rely on fixtures (#1325)
* Introduce ExDoc.DocAST (#1324)
* Add Dialyzer Mix task (#1321)
* fix ast_to_html with empty elements (#1323)
* Remove unused Refs.public?/1
* Reimplement ExDoc.Refs.visibility helper (#1313)
* Clarify README requirements
* Add metadata to ast and fix HTML escaping (#1319)
* Misc doc changes (#1316)
* Enhance ExDoc.Markdown.Earmark.to_ast/2 docs (#1315)
* Add missing period in README
* Fallback when we can't format spec, closes #1314
* Update assets
* Improve search input blur handling
* Update assets
* Fix search click behavior when a suggestion refers the current page (#1311)
* Use OTP builds matching the OS on CI (#1305)
* Format
* Add test for %{required(...), optional(...)}
* Fix undefined reference warning for typespecs
* Fix makeup_erlang dependency (#1304)
* Add next/previous at the end of extra pages (#1302)
* Change autolink to return both path and hash for the current module (#1301)
* Update assets and remove other highlight.js refs
* Remove highlight.js in favour of migration to Makeup (#1300)
* Drop jQuery and refactor JavaScript codebase (#1299)
* Revert "Indent spec after line break (#1296)" (#1298)
* Indent spec after line break (#1296)
* Fix autolink to handle URIs with arbitrary scheme part without warning (#1290)
* Update deps instructions for v0.23 (#1289)
* Fix bug for external extensions
* Release v0.23.0
* Don't crash on code blocks like "A.b.C", closes #1285
* Unify app and siblings into apps
* Raise if none of :name or :app are found in mix.exs
* Require Elixir v1.10
* Fix test
* Fix retrieving specs for macros with when, closes #1191
* Update autolink.ex
* Implement suggestions by @wojtekmach
* Move hidden test to warning
* Move warning tests to its own test
* Fix assert_unchanged
* Deal with required() and optional() in map types
* Fine grain warning messages based on Ref's visibility and kind of link
* Store private types to Refs with visibility set as :hidden
* Fix html escaping in the sidebar entries (#1284)
* Respect deps config in autolink (#1281)
* Improve docs for filter_prefix
* Respect deps config in autolink, closes #1278
* Match Elixir v1.12
* Release v0.22.6
* Remove noindex meta tag (#1277)
* Make test that capture IO asyncronous (#1276)
* Replace Foo with AutolinkTest.Foo to avoid race conditions (#1275)
* Fix Sections arrow (#1273)
* Release v0.22.5
* Revert "Accessibility: Restructure headings (#1265)"
* Revert "Add aria-label and title attributes to links (#1266)"
* Release v0.22.4
* Link to the API reference on every page
* As we work to support multiple languages, make the current language clearer
* Recompile assets if they are missing, closes #1269
* Add aria-label and title attributes to links (#1266)
* Accessibility: Restructure headings (#1265)
* Reformat Application (version number) (#1261)
* Sort file entries in .build file (#1262)
* Accessibility: Improve font color contrast (#1259)
* Improve aria-label attributes in search form (#1260)
* Deal with headings without contents in sidebar sections (#1254)
* Break down autolink typespec regex (#1257)
* Fix regex for autolink typespecs (#1256)
* Cleanup commas in list of the documentation (#1251)
* Rename `mix lint.fix` task `mix fix` (#1250)
* Add lint.fix task (#1248)
* Escape HTML special characters in HTML sidebar entries (#1245)
* Fix npm command instructions in README file (#1247)
* Add lint task (#1246)
* Speed up slow tests (#1243)
* Do not run concurrently tests that capture :stderr (#1240)
* Set async: false on earmark tests due to capturing stderr
* Simplify
* Do not warn twice on mix tasks
* Refactor autolink test and raise on duplicate warnings
* Unify mix task warning with the others
* Update tests
* Change Autolink.warn/maybe_warn functions so they keep the original string provided in the documentation (#1235)
* Show different title and message for a empty search value (#1238)
* Release v0.22.3
* Make sure tooltips work with escape ids. Don't show tooltip for module sections and non-html files. (#1234)
* Remove overlapping functions from defaults (#1230)
* Release v0.22.2
* Do not trigger "unknown extra" warning on a reference
* Update CHANGELOG.md
* Update changelog
* Add tests for earmark warnings
* Don't crash on markdown that triggers warning, fixes #1222
* Update CHANGELOG.md
* Fix autolinking of functions with / in name (#1228)
* Escape HTML special characters in sidebar (#1227)
* Escape signature. (#1226)
* Add assertion for typep
* Improve Refs callbacks/types handling and cache hits (#1225)
* Add specs to Refs (#1223)
* Simplify OTP version check
* Update earmark_parser
* Preparing ex_doc to switch to EarmarkParser (#1209)
* Fix basic types (#1218)
* Revamp Refs (#1217)
* Fix keyboard shortcuts on non US keyboard layouts (#1215)
* Redirect to correct file when change version (#1214)
* Update README.md
* Update ci.yml
* Migrate CI from Travis CI to GitHub Actions (#1212)
* Fix auto-linking ./2 and ../2 (#1208)
* Add stage in CI: build docs (#1206)
* Update Contributing section in README (#1207)
* Allow files with no extension in extra files (#1200)
* Update assets
* Fix travis (#1202)
* Hide sidebar-over-content on click/tap outside it (#1195)
* Replace <kbd> with <kbd><kbd> when it represents keys to be hit (#1197)
* Make HTML valid (#1199)
* Simplify build
* Add more Elixir and Erlang/OTP combinations to CI (#1193)
* Fix lint
* Fix tests
* Remove outdated TODO
* Update code snippet
* Update Earmark (#1188)
* Add support for path dependent markdown autolink (#1187)
* Remove duplicate expression from ast_to_html/1 (#1185)
* Fix text overflow in sidebar (#1184)
* Handling snake case terms in search results (#1182)
* Fix grammar (#1181)
* fixup! Update lib/ex_doc/autolink.ex
* Bring back auto-linking to Kernel and Kernel.SpecialForms (#1180)
* Only copy elixir.css or erlang.css
* Correctly link to sibling in Umbrella (#1174)
* Update README to contain current project version (#1175)
* Release v0.22.1
* Make earmark version requirement stricter (#1170)
* Make AST processor hopefully more future proof
* Don't crash on markdown comments, closes #1169
* Ignore fourth element in Earmark ast (#1166)
* Fix documentation of formatters defaults in README.md (#1163)
* Fix documentation of defaults for :formatters (#1162)
* Release v0.22.0
* Rebuild assets
* Fix displaying auto-linked callbacks and types
* Improve autolink tests (#1161)
* Upgrade dependencies, use latest recommendations for webpack (#1155)
* Fix incompatibilities with Elixir master
* Warn when referencing extras that doesn't exists (#1157)
* Fix content type identification
* Move loading to start/2
* Protect from ets table not being there
* Load all built-in Elixir apps, closes #1156
* Move front end configuration to assets/ (#1154)
* Display line numbers for undefined reference warnings (#1152)
* Display moduledoc headings in the sidebar (#1148)
* First compile, then load apps
* Update changelog
* Update undefined reference warning and :skip_undefined_reference_warnings_on option (#1151)
* Special case `Elixir`
* Fix chunk extraction for Elixir module on case-insensitive fs (#1150)
* Fix procesing markdown (#1147)
* Sort modules by group, nested_context, nested_title, id (#1146)
* auto link types with a trailing ! (#1144)
* Update CHANGELOG.md
* Modules grouped by prefix (#1141)
* Sort function names, closes #1133
* Handle nil path in extra links
* Handle fragments
* Improve autolink extra tests
* Auto-link to extras (#1140)
* Make autolinker module parser stricter (#1139)
* Fix custom links
* Bump version
* Use new autolinker
* Add new autolinker
* Drop cmark support
* Vendor Code.fetch_docs/1
* Simplify `mix setup` and `mix build` (#1138)
* Bump acorn from 5.5.3 to 5.7.4 (#1135)
* Fix hidden text selection, hide tooltips for details link (#1134)
* Update mix.lock
* Add missing dependencies
* Fix suite
* Clarify docs generation output
* Fix JS specs
* Move specs out of signature
* Adds epub to the default formatters (#1129)
* Added parens in ex_doc script (#1127)
* Simplify exception handling in autocomplete suggestions (#1126)
* Add missing parens
* Release v0.21.3
* Run formatter
* Add unit tests for automatic group detection
* Do auto detection of both Exceptions and Deprecated
* Make Exceptions a sub-grouping inside modules (#1124)
* fix typo (#1120)
* Bump handlebars from 4.1.2 to 4.3.0 (#1118)
* Rely on `prefers-color-scheme` w/o night mode set (#1114)
* Remove plugins from Earmark config options (#1113)
* Bump mixin-deep from 1.3.1 to 1.3.2 (#1111)
* Bump eslint-utils from 1.3.1 to 1.4.3 (#1112)
* Allow plain link popups, improve security (#1110)
* Earmark version bump (#1109)
* Run the formatter
* Strength regular expressions throughout
* Simplify typespec autolinking (#1103)
* Do not use @main as color on night mode
* Fix JS suite and lint errors
* Add Erlang style
* Prep work for language-based styles
* Rely on the regex to extract all autolink information
* Remove dup clauses on autolink
* Remove unused functionality, organize code
* Run the formatter
* Add a simple JSON encoder to simplify code
* Update README.md
* Make sure to get funArity as last
* JS lint
* Boost title on search results, add fun/arity to title
* Mention keyboard shortcuts first
* Improvements to search engine
* Change autolink placeholder to something less likely (#1092)
* Link to callback docs instead of copying them (#1094)
* Remove extra night-mode padding in .hljs (#1090)
* Ignore escript in .gitignore (#1089)
* Release v0.21.2
* fully document :source_url_pattern (#1086)
* Update README.md
* Readme: Add link to main configuration listing (#1082)
* Support autolinking for multiple arities (#1080)
* Ignore non-Elixir modules when missing chunk
* Only check for module loaded after getting docs chunk
* Make index redirect warning case-sensitive (#1077)
* (fix): Run tests that require a GUI with xvfb
* (epub): Avoid duplicate IDs on Package Definition
* (epub): Fix broken links to remote types
* (epub): Fix broken links to typespecs
* Add deprecation notice on EPUB format
* Filter out packages without docs on HexDocs in quick-switch (#1071)
* Add hardcoded packages to the quick-switch search results (#1069)
* Warn on unavailable local functions (#1067)
* Simplify handling of invalid link
* Do not create a custom link when destination does not exist
* Hide screen reader elements on EPUB format (#1063)
* Avoid deprecation warnings with Earmark >1.3.2 and use pure links (#1064)
* Run formatter
* Release v0.21.1
* Use samp tags only on EPUB, closes #1062
* Defocus input on switch close (#1060)
* Tooltips - Don't use dynamic requestId to avoid re-fetching the page (#1054)
* Update tooltips.js (#1052)
* Raise nice exception for missing ExDoc.Config
* make use of the makeup lexer registry
* Ensure ExDoc app is started before use by front-ends
* Fixes
* Tidy up and list all features in the README
* Add some width to support large version numbers
* Release v0.21.0
* Configure Makeup to use <samp> instead of <span> (#1040)
* Do not strip "Elixir." from text in fully namespaced calls (#1044)
* Handle fully namespace modules correctly
* Add Reference Popovers (#1025)
* No need to escape URI encoded result as URI encodes <, >, and double quotes
* Encode URL fragments with a URI.encode/1 (#1042)
* Use stages in Travis (#1039)
* Travis: Reverse sort Elixir versions in matrix (#1037)
* Update formatter and travis (#1035)
* Add Quick-Switch modal (#1028)
* Correctly check for night mode status (#1032)
* Add support for :authors config (#1029)
* Fix 'view source' link positioning inside the details element (#1024)
* Cleanup epub css and tidy up layout css
* Set initial color, closes #1022
* Support for custom cover for epub (#1021)
* Fix toc without groups (#1020)
* Fix tag mismatch error
* Fix typo (#1017)
* Revert "Struct has random order"
* Fix test suite
* Reduce API surface
* Struct has random order
* Remove shade of blue from dark header
* Keep links purple on night mode
* Ensure escaped characters are rendered in sidebar (#1011)
* Detect if browser prefers night mode (#1006)
* Update npm lock
* Fix grammar in README (#1003)
* Ensure that link_headings generates unique anchor id's (#1002)
* Release v0.20.2
* Speed up Safari scroll, by removing overflow-y (#1001)
* Prevent text casing of codes (#1000)
* Make the linter happy
* Improvements to search
* Remove unecessary titles
* Add "mix " to Mix tasks (#995)
* Use single quotes
* Remove outline on focus and keep width in version dropdown
* Do not fail if we can't persist index, closes #993
* Release v0.20.1
* Style fixes to version dropdown
* Use ? for keyboard shortcut hint
* Do not show spinner on empty search, closes #990
* Update earmark dependency
* Release v0.20.0
* Use docs_config.js instead
* Push Earmark to v1.3 (#988)
* Rename config.js to ex_doc_config.js
* Search autocomplete (#985)
* Update CHANGELOG
* Run the formatter in released Elixir version
* List delegation docs if delegate_to metadata is present
* Keep structs in signature, closes #973
* Remove double var
* Provide search help on invalid syntax
* Ignore : in search as it is not stemmed anyway, closes #983
* Make the linter happy
* Do not render to markdown multiple times
* Move shared dependency to HTML
* No longer depend on Poison
* Improvements to full text search
* Fix required double click on sidebar for safari
* Full text search (#974)
* Keyboard shortcuts - improvements (#982)
* Fix issues with JS events under non-webkit browsers (#980)
* Add keyboard shortcuts (#976)
* Added ARIA-label to the search button
* Fix anchors in Firefox/Chromium
* Revert "Remove overflow on content, closes #972"
* Keep trailing periods in summaries (#977)
* Reduce size of app-vsn annotation
* Remove overflow on content, closes #972
* Add a versions dropdown to the html sidebar (#970)
* Improve mouseover and titles on goto, related to #968
* Add titles to sidebar top-right icons
* Name args in Autolink.default_text/4 helper (#957)
* Fix typespec arg number (#966)
* Reduce hljs FOUC to colors only (#960)
* Use the goto arrow consistently on expansions
* Add extra padding
* Always show link
* Remove broken link
* Release v0.19.3
* Hide formatter modules
* Allow direct external links on the sidebar
* Fix sidebar margin on Firefox
* Add goto icon
* Raise error message for unknown docs chunk
* Fix anchor links sometimes not working by moving js to html head (#962)
* Unify code styling for makeup and hljs (#959)
* Run the formatter
* Clean up default text handling
* Fix custom links in Elixir modules (#955)
* Remove border-left on deprecated to not mistake it with a heading
* Simplify version/0 test (#949)
* Remove module HTML page from local links (#950)
* Relaese v0.19.2
* Update .gitignore
* Fix code color in html (#940)
* Use same format as in mix.exs generated with Elixir v1.7 for dependencies (#945)
* Use em-dash for separation in page title (#943)
* Improve warning message
* Warn on undefined remote functions from project's docs (#930)
* Skip impl module nodes
* Disable earmark smartypants option by default (#929)
* Make function signature be an H1 element (#926)
* Fix search input color, closes #920
* Autolink `mix help TASK` (#919)
* Autolink Hex docs (#918)
* Sort function names alphabetically in the sidebar (#917)
* added condition for empty `nested_context` (#915)
* Don't emit a redundant entry for nesting (#914)
* Always expand Elixir lib dirs (#912)
* Format test file
* Explicitly list @regexes entries
* Autolink mix tasks (#911)
* group_modules_by_nesting -> nest_modules_by_prefix
* Compute nesting when module is created
* Collapse nested module names (#907)
* Format lines
* Remove unused ExDoc API
* Rewrite Autolink tests to use project_doc/2 (#908)
* Run the formatter
* Preprocess code when building replace_fun
* Refactor autolink functionality (#896)
* Update asset build pipeline (#901)
* Updated makeup_elixir version (#900)
* Add :api_reference option (#899)
* Fix typo in mix task docs (#890)
* Remove stale references to hoedown (#888)
* Group functions based on metadata (#879)
* Fix javascript error in search page (#885)
* Pushing Earmark dependency to 1.2.5 (#884)
* Add svg support (#883)
* Add changelog doc page (#882)
-------------------------------------------------------------------
Tue Dec 11 12:31:00 UTC 2018 - matwey.kornilov@gmail.com
- Use %license for LICENSE
-------------------------------------------------------------------
Mon Dec 10 14:05:49 UTC 2018 - opensuse-packaging@opensuse.org
- Update to version v0.19.1:
* Release v0.19.1
* Update README.md
* No longer write sourcemaps since in dev we don't minify
* Remove --debug flag
* Only include .map files in dev builds
* Format codebase and check formatting on CI (#880)
* Update travis
* Use latest .css versions
* Add mix build instead of overriding mix docs
* Release v0.19.0
* Relax makeup_elixir dependency
* Apply @tmbb's suggestions to theme css
* Fix search.spec.js
* Also work on Elixir earlier versions
* Have a dedicated section for guards
* Allow apps to be excluded from umbrella app docs (#871)
* Upgrade to Elixir v1.8-dev
* Run on 1.7.0-rc.0
* Improve contributing instructions
* Release v0.19.0-rc
* Update error notice to mention earlier ExDoc
* Update dependency (#870)
* Further group tests
* Refactor templates tests (#869)
* Handle booleans, operators and names
* Add missing highlight rule, remove focus from prompt
* Switch themes
* Add since information
* Formats more files and structures more tests
* Trim EEx contents to reduce HTML size
* Add deprecated boxes
* Update install steps
* Do not include epub dist files in diff either
* Simplify assets handling instructions
* Use makeup for Elixir syntax highlight
* Add @nscyclone to maintainers list
* Add missing timeout
* Autolink to the longest libdir possible, closes #864
* Build from Elixir master
* Use async_stream and avoid recomputing autolink cache
* Upgrade to Elixir v1.7
* Adding a reference to the ExDoc hex documentation (#862)
* Autolink Kernel and Kernel functions and special forms with shorthands
* Use Code.ensure_load? instead of Version.Compare
* Avoid warnings after split of Kernel.Typespec into {Kernel,Code}.Typespec
* Exclude types with `@typedoc false` from the docs (#858)
* Add negative lookbehind to support linking after block code snippets (#856)
* Link directly to page if sidebar item has no subitems (#855)
* Run npm install
* Migrate to npm from yarn
* Improving spacing on ul/li
* Autolink "/" function (#850)
* Add contribution instructions (#848)
* Do not append () in __STACKTRACE__ signature (#846)
* Fix generating invalid JS when module name contains double quotes (#842) (#844)
* Fix autolinking when running as escript (#841)
* Improve function and variable names for getting elixir source
* Increase spacing on list items
* Use [rel="noopener"] on external links (#839)
* Add plugins support to Earmark processor (#838)
* Don't allow selecting iex> in doctests (#836)
-------------------------------------------------------------------
Mon Dec 10 11:19:24 UTC 2018 - matwey.kornilov@gmail.com
- Use %license for LICENSE
-------------------------------------------------------------------
Sun May 27 17:06:21 UTC 2018 - opensuse-packaging@opensuse.org
- Update to version v0.18.3:
* Update highlight to v8.5
* update earmark to fix some doc format
* Update earmark
* Release v0.7.3
* Fixed HTML5 markup validation errors.
* Delete output directory before generate docs.
* Add support for fenced code blocks
* Update highlight to v8.6
* Handle code blocks with and without language spec
* WIP: Frameless docs + New Menu
* Avoid code duplication in some templates
* Avoid to assigning to a built-in variable
* Navigation as links instead of buttons
* Improve styling of generated docs
* Index priority: Main -> README -> Overview
* Empty #full_list is there is no nodes available
* Delete useless fixOutsideWorldLinks function
* Generate module pages asynchronously
* Ensure macro callbacks are included in docs
* Avoid double click in a sidebar link after search
* Fix the switch between nav elements
* quote commands in bin file
* off-canvas navigation for ExDoc
* Inline breadcrumbs with button
* Add label tag element for search input field
* Add icon to identify external links
* Detect module type and filter the sidebar elements
* Focus in the search box after clear search term
* Current module page link should point to the top
* Disable nav link when module type list is empty
* Test when module type list is empty
* Limit the module types in the navigation area
* Update local links to the current page
* Breadcrumb generator now links to #content section
* Better scroll behavior in the sidebar area
* Update highlight.js to v8.7
* Update style.css
* Update style.css
* Do not use h2 for headers to not mix with h2 in docs
* Allow ctrl+clicks and show current page as clicked
* Make search button fully clickable
* Always perform search on tab change
* deal with empty table cells
* Expand summary tables to the width of the page.
* Update Bootstrap to v3.3.5
* Increase margins in #content
* Release v0.8.0
* Avoid to use a function before its definition
* Improve events when ESC or ENTER keys are pressed
* Correct highlight.js version number
* Add styles back to docstrings, closes #262
* Do not create doc test folder out of /test/tmp
* Clean up `test/doc` on setup, not on exit
* remove reference to 'relpath'
* sort alphabetically config & templates
* Licenses updated
* Keep breadcrumbs and content aligned
* Use negative margin only on left side of breadcrumbs
* Release v0.8.1
* Update readme to v0.8
* fix PATH in bin/ex_doc
* Update README.md
* feat: Setup build task for web assets using gulp.
* Improve README for assets
* Reapply changes made to the old style.css
* Update CSS rules for distribution
* Redirect template added & Duplicate index page removed
* Change ExDoc.Formatter.HTMLTest to use ExDoc.generate_docs/3
* fix: Remove breadcrumbs overlap in Firefox.
* Corrections as suggested by José
* Pattern match File commands on setup
* Better performance on fillSidebarWithNodes function
* Cleaner redirect template * Removes text from telling user is being redirected * Javascript redirection removed * Show only project name in <title> * Move <meta charsert> to the very top * Add: <meta name="index" content="noindex" />; so it's not indexed by search engines
* align text in the ExDoc.CLI help
* remove closing "/" from void meta tag in head_template
* Add Project Name and Version to <title>
* Get rid of "~r//" in favour of "~r{}"
* head_template standardized & titles improved
* Move sidebar_items.js into 'dist' directory
* Use proper height instead of class row
* .gitignore: sort alphabetically + npm-debug.log
* Release v0.8.2
* Update CSS dist file
* Support callback_docs from Elixir v1.1
* Release v0.8.3
* Add default style for <blockquotes>
* delete css/style.css and css/ folder
* LICENSE: update path to file
* Avoid failures no missing callbacks
* Fix mix.lock
* Generate upcase README
* Release v0.8.4
* Test sets main as "README"
* change filename in test to README.html
* Add version to ExDoc
* Do no show diff in /lib/ex_doc/formatter/html/templates/dist/*
* Include ExDoc version in html meta tag
* Create test that checks for the tags in the html head (index.html and module pages)
* Enforce call to ExDoc.Formatter.HTML.run/3 to be done from ExDoc, and not directly.
* Revert "Merge pull request #303 from eksperimental/enforce_call_from_ex_doc_FIX"
* Fix anchor links when node type is callback/type
* Refactor sidebar items generator
* Fix indent error reported by ESLint
* Update distribution files for JavaScript
* Use stable Elixir
* New design for ExDoc
* Add back reference for the color them
* Update tests
* Replace Glyphicon with Font Awesome
* Accessible icons
* assets: Improve watch tasks
* assets(js): Remove unused classes from sidebar generation
* assets(less): Improve sidebar styles
* assets(less): Code review fixes
* assets(less): Remove sidebar toggles
* assets(less): Only include what's needed from bootstrap
* Add a footer section
* Delete links to top
* Delete icon for external links
* Normalize CSS class names
* Update dist files
* assets(less): Add header
* assets(less): Improve content typography
* assets(less): Remove breadcrumbs
* assets(less): Small cleanup for the headings selectors
* assets(js): Fix hidden anchor links
* Improve function rendering
* Add icon on external links
* Avoid overlap between search input / list of links
* Add Handlebars loader module for webpack
* Add Handlebars support
* Update JS dist file
* Include ExDoc version in footer area
* Add a 404.html error page (not found)
* Start work on new sidebar and cleanup
* Fix tests
* Fix sidebar when scrolling
* New JSON structure for items in the sidebar
* Adapt sidebar to display function list
* Add blockquote styling
* Add open/close functionality to the sidebar
* TravisCI: Migrate from legacy to container-based
* Fix ESLint error (padded blocks)
* [TravisCI] Cache ExDoc dependencies
* Add hover to sidebar items
* Fix for opening the sidebar on desktop
* Fix sidebar variables
* Add summary styles
* Add footer styles
* More content style improvements
* Improve mobile support.
* Move the summary links into the sidebar.
* Fix ESLint padded block error
* assets: Fix linting
* Display search results in the content area.
* Search on icon click
* Add close link to the search results
* Ensure search works in nested definitions
* Ensure links are working when clickin search results
* chore: Udate dependencies
* [sidebar] Highlight selected nodes.
* Improve max-width and padding of the main content
* Remove padding from search result highlights
* [sidebar] Move search to the top
* Build
* [search] Show message when empty
* [search] Clear input on escape
* build
* [content] Ensure inline code is not italics.
* [sidebar] Highlight current hash on page load
* build
* [sidebar] Fix for initial highlighting
* Add logo support
* [sidebar] Ensure the sidebar toggle is visible on iOS.
* [sidebar] Improve logo positioning
* Remove has_readme variables from templates
* [content] Fix left side content pading for mobile
* Add logo instructions
* [content] Add table styles.
* [sidebar] Improve sidebar item layout.
* [sidebar] Improve scrolling on page load and #content.
* [content] Remove external links identifier
* [content] Update footer with attributions
* Document :logo for mix
* Ensure logo file exists on copying
* Fix callbacks
* [assets] Setup babel
* [assets] Convert to es6 modules
* [assets] Convert tests to es6
* [sidebar] Refactor animations and image display
* [content] Improve type listings
* [content] Improve spec listings.
* Add line breaks for long typespecs
* calculate the length without links
* [sidebar] Scroll whole sidebar on small screens
* [sidebar] Reduce link area
* build
* Ensure hashes are escaped properly
* [sidebar] Add functions back into the sidebar.
* Fix scrolling to targets
* Add extra Markdown files as an option
* Add extra option to the usage documentation
* Use extra_template instead of readme_template
* Add -l as an alias for --logo
* Add --extra option via command line
* Improve config merge
* Add extras and title option
* Sort items from Config struct
* Replace --readme option
* Generate README as an EXTRA
* Improve <title> creation for EXTRA files
* Keep backward compatibility
* Helper for extra files titles in the sidebar
* List all extra files in the sidebar area
* Update template tests
* Update HTML formatter tests
* Update minimum command-line options tests
* Add an alias for --extra option
* Replace :readme option in Mix task
* Error message begins in lowercase
* Revert mix.lock
* Add sample for logo and extra options.
* Remove readme option from CLI and Mix
* Slightly cleanup extra code
* Update CHANGELOG
* Fix import statement
* [sidebar] Add vendor prefixes to animation css.
* Improve CHANGELOG
* Release v0.9.0
* Version bump: v0.9.1-dev
* Correct test to check actual version without using a regex
* Add metadata for Hex
* Replace `Dict` calls with `Map` ones
* Simplify default callback doc definition
* Do not add spaces after { and before }
* Make "View Source" to show actual definition
* Alias `Kernel.Typespec` inside `ExDoc.Retriever`
* Add an image as a fixture
* Add more unit tests
* Add ExCoveralls as a coverage report tool
* Use an empty logo instead of the Elixir logo
* Add consistency to declare a given environment
* Fallback to doc line if there is no fun definition in abstract code
* Fix the build
* Disable build per environment as all envs have the same config
* Add pre-commit checks
* Post coverage to travis
* [search] Do not escape anchors.
* [assets] Replace deprecated modules
* [content] Fix inline code alignment
* [search] Properly handle empty sections
* Add signature to types
* Add more to_var casting
* [content] Add section titles and all categories to the summary.
* coveralls.io badge
* [content] Improve footer text and display
* Slightly improve docs
* Ensure we emit all nodes
* Fix 404 page with new layout
* Always link to config.main if there is no homepage, closes #391
* Do not emit items if they have no nodes
* [assets] Use custom highlight.js build
* Add more languages to highlightjs
* Generate extras in sidebar metadata
* Clean up sidebar assertions
* Display pages as a nested list
* Adios coffeescript
* Replace _ with - in html elements
* *-details and *-summary elements removed
* Fix new elements
* Handle initial page loads with extras
* [sidebar] Show headings for the extra pages
* add built app assets
* Fix extras markup
* Always include a module type
* Clean up code and APIs
* Clean up more code, avoid duplication
* Fix broken internal link: type in summary_item_template.eex
* Rename overview to API Reference and prefix extras
* Use extra-downcase for extra filenames
* [sidebar] More compact styles
* Move id from section to div for scrolling
* [sidebar] Align toggle to the top
* [content] Fix header alignment
* [assets] Replace font-awesome with a custom bundle
* Update generate_assets to be a public function
* Add documentation and test for generate_assets
* Include ExDoc.Formatter.HTML docs
* Fail if we cannot create output dir for assets
* [assets] Load google fonts via css
* [content] Ensure code and image links are not underlined
* ExDoc.CLI: support --version option
* Fix tests
* [content] Add links to section headers
* [search] Do not close with modifier key pressed
* spec : move id to a better possition
* Validate with html5
* Do not escape id/anchors so they work as expected
* code clean up
* Sort data in the retriever
* fix anchor link
* Update build
* Update license
* Validate anchor links in sidebar + fix summary sorting
* fix JS error when element doesn't exit on helper.scrollTo
* Remove scrolling on page access, closes #433
* Scroll to top on searches, closes #415
* Search: deal with alternative keys pressed when accessing links
* Only annotate search results
* Release v0.10.0
* Make linting happy
* version bump to 0.10.1-dev
* Use Mix to compile fixtures
* No longer copy fixtures to tmp
* Add specs to ExDoc.Retriever.docs_from_*
* Remove trailing period and colons from summaries
* Add tests for: guess_url, find_formatter
* Add tests to verify min, max qty of args via CLI
* improved instrucitons for getting help
* Code clean up
* Improve module docs
* dynamo -> ecto in examples
* Give example of -e flag.
* Fix autolink anchors for non URL safe function names
* GH-453: warn, don't raise when module lacks --docs
* Add project's name in the content on small screens
* Switch mix.lock GitHub URLs to https://
* Add the version number of the project
* Avoid overlap in search results
* [assets] Generate reved assets
* Include asset's hash in the header and footer
* Update CSS and JS bundle files
* Simplify the params needed by asset_rev
* Allow user define title for additional pages
* Allow user define title for additional pages
* Add a max-width property to img tags
* Update bundle CSS file
* Get rid of the 'extras-' prefix
* Fix indentation for valid_extension_name?
* Allow definition of the path/title for extra files
* fix typo in ex_doc module
* Use first <h1> as menu title if title is not configured
* fix(ExDoc.Retriever): fix invalid arguments for callbacks
* chore(ExDoc.Retriever): pattern match :| for types
* Decrease size of headings in the detail section
* Avoid warning on vars defined inside a conditional
* Avoid string() type, use String.t instead
* fix grammer on markdown module
* fix a typo in markdown module
* fix grammar in markdown module
* fix letter casing in markdown module
* Enhancements and bugs fixes for release v0.11.0
* Improve Changelog format
* Release v0.11.0
* Add project description
* Version dump to 0.11.1-dev
* warn when module lacks __info__/1 not --docs flag
* Ensure modules with structs still have callbacks read
* Release v0.11.1
* Start 0.11.2-dev
* Take advantage of extra space on large screens by widening sidebar
* Add night mode toggle button and basic functionality
* Add night-mode styling
* Clean up extra space and empty blocks.
* Correctly link to bundle css/js files in dev mode
* Add reference to sidebar_items.js in the header
* Don't abort by timeout of Task.await
* Modify night mode styles
* Remove extra viewport meta tag
* Group together meta tags
* Release v0.11.2
* Update generated assets
* Add support for cmark.ex markdown processing.
* support doc of @macrocallback
* Add Cmark to list of markdown processors
* Reformat alternate parser instructions
* Revert "Take advantage of extra space on large screens by widening sidebar"
* Release v0.11.3
* Fix cmark.ex dependency line
* Downcase generated id from header to be consistent with GitHub format.
* Ensure to escape headers
* Fix ligature issue on Firefox and Safari
* Fix ligature issues in recent browsers
* Release v0.11.4
* Improve docs for mix task
* Revert "Fix ligature issue on Firefox and Safari"
* Revert "Fix ligature issues in recent browsers"
* Fix elixir 1.3.0-dev warnings
* Fixed handling output of if statement
* Use canonical URLs
* Support canonical in the mix task command line
* Fix failing test
* Add atom module name to list for doc generation
* focus on content element on document ready
* Sort specs by line to preserve ordering
* Fixes #528, autolink regexp now allows digits in function names.
* Delete extra list marker (#531)
* Release v0.11.5
* No longer make earmark an optional dependency
* Fix `source_path` return of char list (#535)
* Fix search input height (#537)
* Add xref exclude to `mix.exs` for `Cmark` and `Markdown`. (#538)
* Close the search results after click at the sidebar menu (#539)
* Fix a typo in `print.less` (#542)
* Update general.less to better support nested list (#543)
* #540 improve sidebar animation (#544)
* Fix content background to cover sidebar on all device heights #545 (#545)
* Fix a comment in `events.js` (#547)
* Change night search colors. (#548)
* Fix the vertical align of inline code (#549)
* Remove outdated css file
* Fix the text decoration for links containing code (#551)
* Add support for optional behaviour callbacks (#550)
* Add styling to annotations
* Remove an unused class from `functions.less` (#552)
* Fixes for night mode and safari scrolling
* Optimize closing search results by hidding only direct children instead of all children
* Fix js lint errors (#554)
* Release v0.12.0
* Verify callbacks with no docs included (#527)
* Fix Elixir 1.4 warnings (#555)
* Updated README to reference latest version for deps (#566)
* Fix flash of unstyled content (#568)
* Removing compiler warning in OTP 19 (#570)
* Improve the visibility of the menu icon (#564)
* Generate hover links for subtitles in moduledocs (#559)
* Update generated files
* Expand path before calculating relative path
* Do not change meny color on closing
* Hover links for secondary headings in Pages (#576)
* Fix page shaking when switching modes (#577)
* Update version of earmark to 1.0 (#574)
* Require Elixir v1.2
* Use proper language on Travis CI
* Use :erl_anno to fetch the line on Erlang 19
* Update CHANGELOG
* Move assets to priv dir (#582)
* Release v0.13.0
* Add (callback) to search results (#583)
* Fix the opened `.sidebar-toggle` position on small screens (#584)
* Remove extra CSS and rebuild (#585)
* Remove unused fonts from font list (#586)
* Remove docstring class from moduledoc
* Local Callbacks (#588) (#589)
* Autolinking to types (#590)
* Allow horizontal scroll for code snipper on mobile devices (#594)
* Correct the commentary for the `ExDoc.Markdown` module
* Stop escaping linked h2s (#591)
* Link h2s in detail templates (functions, macros) (#596)
* Align all h2 section headings correctly (#597)
* Keep track of generated files
* Simplify autolinking of erlang functions
* Support linking to Elixir functions and modules, closes #599
* Optimize ex_doc generation by caching elixir_lib_dir
* Release v0.13.1
* Remove unecessary scroll back on all code snippets
* Release v0.13.2
* Give higher preference to Mix commands
* Add EPUB formatter
* Include canonical in docs examples
* Define new types
* Update XML header to be consistent
* Add support for handling settext headers and stripping links from the primary header for link generation (#600)
* Return gulp pipeline in `javascript` and `less` functions
* Do not raise if the module source is not available
* Clean up exdoc guides API
* Convert font pixels to em, see #606
* Indent docstrings inside function sections
* Revert "Convert font pixels to em"
* Move specs inside the function definition
* Split typespecs only after 70 chars
* Use a gradient on the sidebar
* Increase size and use an ordered list for pages
* Make sidebar items expandable
* Add new navigation to pages too
* Fix back button on Chrome, closes #593
* Cover all background on search pages, closes #608
* Fix lint errors
* Release v0.14.0
* Update CHANGELOG.md
* Ensure API Reference is clickable on the page menu
* Include Top link even on modules without docs
* Release v0.14.1
* Update docs.ex (#612)
* Make lib_dirs a list of directories to traverse
* Update README.md
* Promote main in the README
* Do not list Top twice on pages
* Remove outdated test
* Support linking across dependencies
* Improve docs on autolinking
* Release v0.14.2
* Add maintainers field
* Avoid File.cd! calls due to concurrent tests
* Do not run mix tests with async
* Autolink to functions named %, see #321
* Generates ids for default functions, closes #321
* Include doc generation fix for Elixir
* Include doc_line and source_path on nodes and pass this info to formatters
* Fix Pandoc tests
* Avoid reaching the AST on disk if abst_code is already available
* Export group in pages json
* Update to markdown version without warnings
* Add group key to pandoc tests
* Add more bottom padding to sidebar scrolling
* Update docs.ex
* Add support for page groups (#613)
* Adding vertical padding on submenus and remove horizontal padding on subsubmenus
* Also autolink functions with uppercase characters, closes #616
* Consider defaults when building autolinking references
* Ensure logo is added to .build and overwrites previous entries
* Allow specifying the assets directory that is copied as is
* Ensure assets are generated before extras for proper revisions
* Better support for extra content
* Ensure mimetype file is first
* Use lowercase filenames
* Release v0.14.3
* Actualize the license info for `lodash` (#620)
* Fix the project name appearance (#621)
* Update LICENSE (#623)
* Searching on mobile closes menu when the Enter key is hit (#465) (#624)
* Generate top-level docs for an umbrella project (#625)
* Do not highlight function or type name left of :: (#626)
* Force parens on type signature
* Fix autolinking to opaque type (#627)
* Added underline to content links in night mode (#632)
* Improve docs for setting deps, closes #633
* Filter modules by their prefix (fixes: #628)
* Fix missing assets in the header section
* Also digest sidebar_items.js, closes #638
* Move .eslintrc to source
* Fix issues reported by `credo`
* Add .ebert.yml configuration
* Reenable eslint and a single rule to allow external parsing
* Enable imports
* Pass ecmaVersion instead of turning on features individually
* Remove functions with high arity
* Add Ebert badge
* Update node version on travis
* Remove .svg extension from ebert badge
* Reduce function complexity (#640)
* EPUB format: Fix errors reported by @wsmoak (#643)
* In case function has no docs, use the ones from callback (#641)
* Always append callback information
* Reenable the docs task for multiple invocations
* Allow multiple formatters in mix docs task
* Build extras and generate them in distinct steps
* EPUB format: Drop numbers from TOC
* Reuse extras building in epub formatter
* Remove unecessary output variable
* Declare assets in the OPF manifest (#644)
* Fix relative path to index.html
* EPUB format: Fix relative path to assets
* EPUB format: UL element is not allowed under nav
* EPUB format: Center the content in the title page (#645)
* Point to Elixir docs on hexdocs.pm
* Release v0.14.4
* Removing border around code blocks and increase funtion header font
* Bring codebackground back to light blue but without borders
* Templates modules are private
* Revert changes to function size and line height
* Make ExDoc work as an escript (#651)
* Release v0.14.5
* Properly link to erlang lib dirs
* Automatically detect GitLab source URL patterns (#652)
* List both functions and macros under "Functions" (#653)
* Remove support for Pandoc (#655)
* Limit Travis build matrix to oldest/newest pairs (#656)
* EPUB format: Split TOC in groups (#660)
* .travis.yml: Test on Elixir 1.4.0 (#661)
* Remove *Navigation Center eXtended* document
* Corrects find_actual_line/3 when abstract code is missing (#663)
* Warn when redirecting to a non-existent file (#665)
* Handle __struct__/0 by displaying the struct instead (#670)
* use Earmark.as_html! (#671)
* Closing the search takes you to where you were in the previous page
* Update mix.lock with earmark dependency
* Post coverage from TravisCI
* Fix some issues found by ebertapp.io
* [Mobile] Fix the initial state of the sidebar hamburger
* Update coveralls.io badge in README
* Use a single `@media` query `width` breakpoint for mobile devices (#676)
* Do not require ExDoc at runtime
* Break long specs into lines (#677)
* Release v0.15.0
* Update travis deps
* Use behaviour_info to fetch callback information
* Do not fail if localStorage is not available
* Update deps
* Fix ExDoc.CLI.main/2 to keep --source-ref (#680)
* Fix the build on v1.3
* Add :assets typespec to ExDoc.Config.t/0 type (#684)
* Fix resetting of the night mode state (#686)
* Fix tests on Elixir master
* Fix markdown warnings
* Sort arguments and options alphabetically (#689)
* Add sourcemaps for JS (fixes #687) (#691)
* Properly set link in types with parameter (#694)
* Fix project name wrapping (#697)
* Release v0.15.1
* Small fix in doc
* Fix warning in ExDoc.Formatter.HTMLTest (#702)
* Remove the old search results after every new search attempt (#704)
* Strip nesting html tags in headers. Closes #705 (#706)
* Support default configuations (#708)
* Fix malformed h2 links (#711)
* Improve web accessibility support (#715)
* Setting homepage_url at root level in the config (#718)
* Set EPUB document primary language via configuration (#716)
* Break commands apart so we get better Travis reports
* Remove left-over JS files (and build new ones) (#723)
* Add types to the search results (#724)
* Change font stack based on availability and looking better than times (#722)
* Use String.trim_trailing/1 over the deprecated String.rstrip/1
* Fix callback signature when arguments are typed as functions (#725)
* Deal with http:// when guessing source_url_pattern (#721)
* Sort alphabetically default config and add test for :language
* Raise if version is not provided in Docs task (#729)
* Separate tasks from regular modules (#713)
* Use Mix Tasks in sidebar
* Release v0.16.0
* Fix transition of icons after accessibility changes
* Release v0.16.1
* Revert "Raise if version is not provided in Docs task (#729)"
* [Windows] Fix unit tests
* Update regexes
* Add references to 'Writing documentation' page (#737)
* Add border to code tag (#741)
* Link `<h3>` headings (#744)
* Throttle resize event and fix sidebar disappearance (#742)
* Release v0.16.2
* Update lock deps
* Add proper dist files
* Add unencoded link target for functions with special chars (#754)
* Remove extra term() argument at start of macro spec (#756)
* Fix Search History (#749)
* Highlight the target function (#746)
* Regenerate assets files
* Fix search for file protocol (#759)
* Use relative paths when changing history
* Fix bugs in highlights and search
* Fix the build
* Only generate source maps if necessary
* Markdown modules are now 100% responsible for code (#763)
* Users can now add custom HTML before the closing head tag and the closing body tag (#764)
* before_closing_*_tag works on EPUB too (#768)
* Make search its own page and improve UX
* Update README.md
* Make ebert happy (#772)
* Add favicon when logo option is present (#774)
* Remove version name from epub formatter (#775)
* Release v0.16.3
* Release v0.16.4
* Update .travis.yml
* Update dependencies (earmark, excoveralls) (#776)
* Lock Firefox version to 54.0 for Travis CI tests (#777)
* Add grouping of modules and extras (#780)
* Remove deprecated code, improve group docs
* Remove formatter_opts in favor of a top-level config reader
* Get some vertial sidebar space back
* Remove protocol specific section on sidebar
* Keep groups as atoms for performance
* Sort modules by id
* Release v0.17.0
* Update JS files
* Release v0.17.1
* Revert "Add favicon when logo option is present (#774)"
* Tidy up ExDoc docs
* Allow markdown process to be given via an option
* Remove assets from priv (#785)
* Remove race from tests
* Trailing commas are not allowed in calls
* Do not strip parens from typespecs
* Update travis to use yarn for JavaScript tests (#790)
* Support for custom markdown processor options (#787)
* Merge ExDoc.MarkdownProcessor into ExDoc.Markdown
* Remove built-in support for hoedown
* Remove pending MarkdownProcessor module
* Release v0.18.0
* Include formatters directory in package
* Run prerelease script on travis
* More emphasis on h2
* Fix .main height to 100% (#794)
* Replace css shadow border link underline hack with text-decoration-skip: ink (#797)
* Capitalize search word (#781)
* Make night mode switch link more obvious (#798)
* Run code formatter on typespecs (#800)
* Remove underscore from view source link
* Autolink basic and built-in types in typespecs (#802)
* Clean up hexdocs.pm urls in autolink_test.exs
* Autolink Erlang typespecs (#803)
* Autolink basic/built-in types and special forms in docs (#807)
* Annotate opaque types (#809)
* Autolink Kernel functions (#810)
* Fix autolinking Kernel & Kernel.SpecialForms for Elixir itself (#812)
* Allow custom links for Elixir functions (#813)
* :source_root has no use under mix projects, closes #814
* Add vertical-align:top to tables (#816)
* Make custom link regex non-greedy, closes #817
* Refactor autolinking
* Fix Mix.Tasks.Docs @moduledoc typo (#820)
* Autolink Kernel, Kernel.SpecialForms, and built-in types on pages (#823)
* Fix the web print (#824)
* Release v0.18.2
* Remove warnings on v1.7-dev
* Update jQuery (#827)
* Bundle latest jquery version
* Revert "Replace css shadow border link underline hack with text-decoration-skip: ink (#797)"
* Reintroduce #797 with fixed resets
* Fix formatting typespecs (#832)
* Release v0.18.3
-------------------------------------------------------------------
Sat May 9 10:13:20 UTC 2015 - matwey.kornilov@gmail.com
- Initial version