Skip to content

Some fixes #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 5, 2021
Merged

Some fixes #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1e0d586
Fixed the issue, when we tried to find uppercased xrefs inside inline…
svetlyak40wt Dec 4, 2021
93f3a0b
Added EXTERNAL-LINKS argument to DEFSECTION macro. It can be useful, …
svetlyak40wt Dec 5, 2021
d67e3e8
Now it is possible to use 40ANTS-DOC/IGNORED-WORDS:IGNORE-WORDS-IN-PA…
svetlyak40wt Dec 5, 2021
2095395
Merge branch 'master' into some-fixes
svetlyak40wt Dec 5, 2021
26d259f
Documented ignored-words package.
svetlyak40wt Dec 5, 2021
8fcdfab
Fixed tests.
svetlyak40wt Dec 5, 2021
ba86f4c
Documentation build was fixed.
svetlyak40wt Dec 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 39 additions & 26 deletions ChangeLog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

# ChangeLog

<a id="x-2840ANTS-DOC-2FCHANGELOG-3A-3A-7C0-2E6-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.6.0 (2021-12-05)

* Fixed the issue, when we tried to find uppercased xrefs inside inline code and links.

* Added `EXTERNAL-LINKS` argument to [`defsection`][3e7c] macro. It can be useful, if you have a multiple
text sections having the same external link.

* Now it is possible to use [`40ants-doc/ignored-words:ignore-words-in-package`][0cce]
to suppress warning on symbols which are exported but not documented.

<a id="x-2840ANTS-DOC-2FCHANGELOG-3A-3A-7C0-2E5-2E8-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.5.8 (2021-10-23)
Expand All @@ -12,7 +24,7 @@

## 0.5.7 (2021-10-21)

* [`defsection`][4e8b] macro now supports `EXTERNAL-DOCS` argument.
* [`defsection`][3e7c] macro now supports `EXTERNAL-DOCS` argument.

<a id="x-2840ANTS-DOC-2FCHANGELOG-3A-3A-7C0-2E5-2E6-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

Expand Down Expand Up @@ -40,7 +52,7 @@ Object referenced as #<XREF 40ANTS-DOC/COMMONDOC/XREF:XREF> in ChangeLog / 0.5.3

## 0.5.4 (2021-09-11)

* Included changelog.lisp into the [`40ants-doc`][a2c7] system.
* Included changelog.lisp into the [`40ants-doc`][bdb2] system.

<a id="x-2840ANTS-DOC-2FCHANGELOG-3A-3A-7C0-2E5-2E3-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

Expand All @@ -67,7 +79,7 @@ Object referenced as #<XREF 40ANTS-DOC/COMMONDOC/XREF:XREF> in ChangeLog / 0.5.3

## 0.5.0 (2021-09-06)

* Now [`40ants-doc:defsection`][4e8b] macro accepts `EXTERNAL-DOCS` argument.
* Now [`40ants-doc:defsection`][3e7c] macro accepts `EXTERNAL-DOCS` argument.
Together with `HTML` pages, `references.json` file is rendered, and you can
provide a list of urls of external libraries' documentation to have an automatic
cross-referencing between them.
Expand All @@ -76,10 +88,10 @@ cross-referencing between them.

## 0.4.1 (2021-09-05)

* Function [`40ants-doc/builder:get-current-asdf-system`][15d3] was added. Now you can use it to do something interesting
* Function [`40ants-doc/builder:get-current-asdf-system`][bf98] was added. Now you can use it to do something interesting
like showing "Fork me on the GitHub" stripe [as my own theme do][2fa5].

* Markdown files now will have a footer saying that a file was generated by [`40ants-doc`][a2c7].
* Markdown files now will have a footer saying that a file was generated by [`40ants-doc`][bdb2].

* An `RSS` feed is generated for changelog. Also, changelog items can have a date now.

Expand All @@ -88,7 +100,7 @@ cross-referencing between them.
## 0.4.0 (2021-09-05)

* `*DOCUMENT-NORMALIZE-PACKAGES*` variable was replaced with `FULL-PACKAGE-NAMES` argument
of [`40ants-doc/builder:render-to-files`][05c0] function.
of [`40ants-doc/builder:render-to-files`][084c] function.

<a id="x-2840ANTS-DOC-2FCHANGELOG-3A-3A-7C0-2E3-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

Expand All @@ -99,7 +111,7 @@ of [`40ants-doc/builder:render-to-files`][05c0] function.

* Added a protocol to define new color themes and change page layout.
Three new themes are available out of the box.
Read more at [`Defining a Custom Theme`][bcaa] section.
Read more at [`Defining a Custom Theme`][22a0] section.

<a id="x-2840ANTS-DOC-2FCHANGELOG-3A-3A-7C0-2E2-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

Expand All @@ -116,7 +128,7 @@ of [`40ants-doc/builder:render-to-files`][05c0] function.
* Now defsection does not export nor mentioned symbols nor the name of the section
It is better to have explicit exports.

* [`40ants-doc/locatives:include`][359f] locative now does not support `:HEADER`, `:FOOTER` and some other arguments. Use `:LANG` argument instead.
* [`40ants-doc/locatives:include`][e263] locative now does not support `:HEADER`, `:FOOTER` and some other arguments. Use `:LANG` argument instead.

* Added code highlighting using Highlight.js library.

Expand All @@ -126,12 +138,12 @@ of [`40ants-doc/builder:render-to-files`][05c0] function.
* Elisp code for transcriptions was fixed and now should word not
only with `SLIME`, but also with `SLY`.

* [`40ants-doc:defsection`][4e8b] macro now does not generate export code
* [`40ants-doc:defsection`][3e7c] macro now does not generate export code
if `:EXPORT` argument is `NIL`.

* Functions `UPDATE-ASDF-SYSTEM-HTML-DOCS` and `UPDATE-ASDF-SYSTEM-README`
were replaced with [`40ants-doc/builder:update-asdf-system-docs`][0983], which also supports
ChangeLog.md generation. Use [`40ants-doc/changelog:defchangelog`][8c40] to define versions.
were replaced with [`40ants-doc/builder:update-asdf-system-docs`][f11d], which also supports
ChangeLog.md generation. Use [`40ants-doc/changelog:defchangelog`][28eb] to define versions.

* Variables `*DOCUMENT-HTML-MAX-NAVIGATION-TABLE-OF-CONTENTS-LEVEL*` and
`*DOCUMENT-MAX-TABLE-OF-CONTENTS-LEVEL*` were removed. Probably we'll return this
Expand All @@ -140,7 +152,7 @@ of [`40ants-doc/builder:render-to-files`][05c0] function.
* Removed `LOCATE-AND-DOCUMENT` generic function.

* Links to the GitHub now are generated automatically,
if [`40ants-doc/builder:update-asdf-system-docs`][0983] function is used
if [`40ants-doc/builder:update-asdf-system-docs`][f11d] function is used
and system definition has a `:SOURCE-CONTROL` slot.

* Generic functions `COLLECT-REACHABLE-OBJECTS` and `LOCATE-AND-COLLECT-REACHABLE-OBJECTS`
Expand All @@ -150,7 +162,7 @@ of [`40ants-doc/builder:render-to-files`][05c0] function.

* Variable `*DOCUMENT-MIN-LINK-HASH-LENGTH*` was removed. Use `COMMONDOC-MARKDOWN:*MIN-LINK-HASH-LENGTH*`

* Functions [`40ants-doc/builder:update-asdf-system-docs`][0983] and [`40ants-doc/builder:render-to-files`][05c0]
* Functions [`40ants-doc/builder:update-asdf-system-docs`][f11d] and [`40ants-doc/builder:render-to-files`][084c]
now accept `WARN-ON-UNDOCUMENTED-PACKAGES` argument and `CLEAN-URLS` argument.

* Variable `*DOCUMENT-MARK-UP-SIGNATURES*` was removed.
Expand All @@ -160,13 +172,13 @@ of [`40ants-doc/builder:render-to-files`][05c0] function.

* Added warnings on symbols, referenced like internals, using `::`.

* Added [`40ants-doc:defsection-copy`][ad02] macro to define copy of the section but with a different name.
* Added [`40ants-doc:defsection-copy`][15ec] macro to define copy of the section but with a different name.

<a id="x-2840ANTS-DOC-2FCHANGELOG-3A-3A-7C0-2E1-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.1.0 (2021-05-01)

* Project forked from [`MGL-PAX`][7927].
* Project forked from [MGL-PAX][7927].
Code refactored into the package inferred system and core is separated
to have minimum dependencies.

Expand All @@ -176,7 +188,7 @@ of [`40ants-doc/builder:render-to-files`][05c0] function.
file-subseq function was rewritten.

* Locatives can be specified without a package prefix inside the defsection
because all locative symbols now live in [`40ants-doc/locatives`][d889] package.
because all locative symbols now live in [`40ants-doc/locatives`][dd8b] package.

* Function update-asdf-system-readmes was renamed to update-asdf-system-readmes and now
it generates only one `README` file.
Expand All @@ -198,19 +210,20 @@ of [`40ants-doc/builder:render-to-files`][05c0] function.
* Fixed docstring extraction for compiler macro.


[a2c7]: https://40ants.com/doc/#x-28-23A-28-2810-29-20BASE-CHAR-20-2E-20-2240ants-doc-22-29-20ASDF-2FSYSTEM-3ASYSTEM-29
[d889]: https://40ants.com/doc/#x-28-23A-28-2820-29-20BASE-CHAR-20-2E-20-2240ANTS-DOC-2FLOCATIVES-22-29-20PACKAGE-29
[15d3]: https://40ants.com/doc/#x-2840ANTS-DOC-2FBUILDER-3AGET-CURRENT-ASDF-SYSTEM-20FUNCTION-29
[05c0]: https://40ants.com/doc/#x-2840ANTS-DOC-2FBUILDER-3ARENDER-TO-FILES-20FUNCTION-29
[0983]: https://40ants.com/doc/#x-2840ANTS-DOC-2FBUILDER-3AUPDATE-ASDF-SYSTEM-DOCS-20FUNCTION-29
[8c40]: https://40ants.com/doc/#x-2840ANTS-DOC-2FCHANGELOG-3ADEFCHANGELOG-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29
[359f]: https://40ants.com/doc/#x-2840ANTS-DOC-2FLOCATIVES-3AINCLUDE-20-2840ANTS-DOC-2FLOCATIVES-3ALOCATIVE-29-29
[bcaa]: https://40ants.com/doc/#x-2840ANTS-DOC-2FTHEMES-2FDOCS-3A-3A-40DEFINING-A-THEME-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29
[4e8b]: https://40ants.com/doc/#x-2840ANTS-DOC-3ADEFSECTION-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29
[ad02]: https://40ants.com/doc/#x-2840ANTS-DOC-3ADEFSECTION-COPY-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29
[2fa5]: https://github.com/40ants/40ants-doc-theme-40ants/commit/917a4c1e72b0379f509bdee4864531e641c9ec4e#diff-47d16baea2d4ef710747f19c24df8cf7ef4f6bbbfd1dbb0ade55f47457b1e8feR155-R161
[7927]: https://github.com/melisgl/mgl-pax
[140c]: https://www.sphinx-doc.org/
[bdb2]: index.html#x-28-2240ants-doc-22-20ASDF-2FSYSTEM-3ASYSTEM-29
[dd8b]: index.html#x-28-23A-28-2820-29-20BASE-CHAR-20-2E-20-2240ANTS-DOC-2FLOCATIVES-22-29-20PACKAGE-29
[bf98]: index.html#x-2840ANTS-DOC-2FBUILDER-3AGET-CURRENT-ASDF-SYSTEM-20FUNCTION-29
[084c]: index.html#x-2840ANTS-DOC-2FBUILDER-3ARENDER-TO-FILES-20FUNCTION-29
[f11d]: index.html#x-2840ANTS-DOC-2FBUILDER-3AUPDATE-ASDF-SYSTEM-DOCS-20FUNCTION-29
[28eb]: index.html#x-2840ANTS-DOC-2FCHANGELOG-3ADEFCHANGELOG-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29
[0cce]: index.html#x-2840ANTS-DOC-2FIGNORED-WORDS-3AIGNORE-WORDS-IN-PACKAGE-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29
[e263]: index.html#x-2840ANTS-DOC-2FLOCATIVES-3AINCLUDE-20-2840ANTS-DOC-2FLOCATIVES-3ALOCATIVE-29-29
[22a0]: index.html#x-2840ANTS-DOC-2FTHEMES-2FDOCS-3A-3A-40DEFINING-A-THEME-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29
[3e7c]: index.html#x-2840ANTS-DOC-3ADEFSECTION-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29
[15ec]: index.html#x-2840ANTS-DOC-3ADEFSECTION-COPY-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29

* * *
###### [generated by [40ANTS-DOC](https://40ants.com/doc/)]
Loading