Skip to content

Fixed the way of how a TOC is built. Previosly it incorrectly shown nested COMMONDOC:SECTION objects. #9

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 2 commits into from
Oct 24, 2021
Merged

Fixed the way of how a TOC is built. Previosly it incorrectly shown nested COMMONDOC:SECTION objects. #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8354054
Fixed the way of how a TOC is built. Previosly it incorrectly shown n…
svetlyak40wt Oct 23, 2021
c05b5be
Use fixed ASDF version in CI while issue in Roswell will not be fixed:
svetlyak40wt Oct 24, 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
3 changes: 2 additions & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@
"name": "Setup Common Lisp Environment",
"uses": "40ants/setup-lisp@v1",
"with": {
"asdf-system": "40ants-doc-full"
"asdf-system": "40ants-doc-full",
"asdf-version": "3.3.5.1"
}
},
{
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
"name": "Setup Common Lisp Environment",
"uses": "40ants/setup-lisp@v1",
"with": {
"asdf-system": "40ants-doc/doc"
"asdf-system": "40ants-doc/doc",
"asdf-version": "3.3.5.1"
}
},
{
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/linter.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
"name": "Setup Common Lisp Environment",
"uses": "40ants/setup-lisp@v1",
"with": {
"asdf-system": "40ants-doc/full"
"asdf-system": "40ants-doc/full",
"asdf-version": "3.3.5.1"
}
},
{
Expand Down
3 changes: 3 additions & 0 deletions src/changelog.lisp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@
"TOC"
"SLIME"
"SLY"
"COMMONDOC:SECTION"
"COLLECT-REACHABLE-OBJECTS"
"LOCATE-AND-COLLECT-REACHABLE-OBJECTS"
"COMMONDOC-MARKDOWN:*MIN-LINK-HASH-LENGTH*"
Expand All @@ -142,6 +143,8 @@
"*DOCUMENT-DOWNCASE-UPPERCASE-CODE*"
;; These objects are not documented yet:
"40ANTS-DOC/COMMONDOC/XREF:XREF"))
(0.5.8 2021-10-23
"* Fixed the way of how a TOC is built. Previosly it incorrectly shown nested COMMONDOC:SECTION objects.")
(0.5.7 2021-10-21
"* DEFSECTION macro now supports EXTERNAL-DOCS argument.")
(0.5.6 2021-10-21
Expand Down
12 changes: 10 additions & 2 deletions src/ci.lisp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,17 @@
(in-package 40ants-doc/ci)


(defparameter *asdf-version* "3.3.5.1"
"At some point installation of the latest roswell version was broken:
https://github.com/roswell/roswell/issues/497")


(defworkflow linter
:on-push-to "master"
:on-pull-request t
:jobs ((40ants-ci/jobs/linter:linter
:asdf-systems ("40ants-doc/full"))))
:asdf-systems ("40ants-doc/full")
:asdf-version *asdf-version*)))


(defworkflow ci
Expand All @@ -21,11 +27,13 @@
:on-pull-request t
:jobs ((40ants-ci/jobs/run-tests:run-tests
:asdf-system "40ants-doc-full"
:asdf-version *asdf-version*
:coverage t)))


(defworkflow docs
:on-push-to "master"
:on-pull-request t
:jobs ((40ants-ci/jobs/docs:build-docs
:asdf-system "40ants-doc/doc")))
:asdf-system "40ants-doc/doc"
:asdf-version *asdf-version*)))
6 changes: 3 additions & 3 deletions src/commondoc/toc.lisp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
(40ants-doc/commondoc/changelog::changelog
(setf inside-changelog t))

(40ants-doc/commondoc/section:documentation-section
(common-doc:section
(push (common-doc:make-unordered-list (list))
current-sublist)
(setf (common-doc:children last-list-item)
Expand All @@ -77,7 +77,7 @@
(typecase node
(40ants-doc/commondoc/changelog::changelog
(setf inside-changelog nil))
(40ants-doc/commondoc/section:documentation-section
(common-doc:section
(pop current-sublist)))))
(40ants-doc/commondoc/mapper:map-nodes document #'collector
:on-going-down #'on-down
Expand All @@ -89,7 +89,7 @@
(setf (common-doc:children node)
(loop for child in (common-doc:children node)
unless (null (common-doc:children child))
collect child)))
collect child)))
node))
(40ants-doc/commondoc/mapper:map-nodes (car current-sublist)
#'remove-empty-sublists))))
Expand Down