Skip to content

[WIP] Use CommonDoc for intermediate documentation representation #2

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

Jump to bottom
Merged
merged 152 commits into from
Aug 28, 2021
Merged

[WIP] Use CommonDoc for intermediate documentation representation #2

merged 152 commits into from
Aug 28, 2021

Conversation

@svetlyak40wt
Copy link
Member

@svetlyak40wt svetlyak40wt commented Jun 26, 2021 •
edited
Loading

This way it will be easier to write custom documentation nodes, locatives and HTML themes.

             *     ,MMM8&&&.            *
                  MMMM88&&&&&    .
                 MMMM88&&&&&&&
     *           MMM88&&&&&&&&
                 MMM88&&&&&&&&
                 'MMM88&&&&&&'
                   'MMM8&&&'      *
          |\___/|
         =) ^Y^ (=            .              '
          \  ^  /
           )=*=(       *
          /     \
          |     |
         /| | | |\
         \| | |_|/\
  jgs_/\_//_// ___/\_/\_/\_/\_/\_/\_/\_/\_/\_
  |  |  |  | \_) |  |  |  |  |  |  |  |  |  |
  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |

@svetlyak40wt svetlyak40wt added the enhancement New feature or request label Jun 26, 2021
@svetlyak40wt
Rendering for classes.
229cfc6
@svetlyak40wt
New render for class slot accessors.
b60163a
@svetlyak40wt
All locatives now can be rendered to common doc nodes.
b829997
@svetlyak40wt
Replaced xref collection with mapper.
67f13bc
@svetlyak40wt
Now using intermediate XREF objects instead of Markdown links to repr…
8603ed8 
…esent references.
@svetlyak40wt
Render multiple references if they where found for XREF.
7d19cb5
@svetlyak40wt
Added support for locative specifiers surrounding a symbol in the doc…
df31b52 
…string.
@svetlyak40wt
Added atomatic XREF generation out of uppercased symbols in docstrings.
73b3d37
@svetlyak40wt
Initial support for pages and themes.
e4281e5
@svetlyak40wt
Fixed matching for @symbols used for sections.
854ee19
@svetlyak40wt
Fixed section xreference rendering as a section name.
39d26ce
@svetlyak40wt
Fixed docstring rendering for classes, slot accessors and a glossary.
13f1c64
@svetlyak40wt
Make header link change a color when we are hovering cursor on it.
dd408b3
@svetlyak40wt
Working toc and multipage mode.
8d518e5
@svetlyak40wt
Now every page has a full TOC in the left sidebar.
0320419
@svetlyak40wt
A replacement for dislocated symbols was made. Now any documentation …
55e24a3 
…section can have attached words to ignore.
@svetlyak40wt
Fixed style for TOC footer.
430d030
@svetlyak40wt
Support packages starting from digits.
b48f8e7
@svetlyak40wt
Fixed eating of a symbol after an extracted xref.
0ef1c71
@svetlyak40wt
Fixed reference rendering in case if document is generated from a pac…
909811a 
…kage other than one where documentation sections were defined.
@svetlyak40wt
Fixed some problems with circular dependencies and such stuff.
8437f4a
@svetlyak40wt
Fixed arglist to markdown rendering.
4bb340d
@svetlyak40wt
Fixed rendering of the code blocks inside docstrings.
88805d5
@svetlyak40wt
List items of asdf-system description are now paragraphs.
b0c5b83
@svetlyak40wt
Fixed unnecessary empty lines.
ac03e95
@svetlyak40wt
Fixed document-links in markdown.
f3ecc50
@svetlyak40wt
Fixed cross links in the markdown render.
fd1a222
@svetlyak40wt
Returned warnings on missing references.
7472e5e
@svetlyak40wt
Implemented support for dislocated symbols in documentation bullets.
e2c1760
@svetlyak40wt
Fixed some symbols.
03b536b
@svetlyak40wt
Documentation warnings were fixed.
5303c61
@svetlyak40wt
Dependency on slynk
3758bed
@svetlyak40wt
Removed old code for replace-known-references and related things.
3651c9a
@svetlyak40wt
Removed footer and mark-up-superclasses function.
d2b9508
@svetlyak40wt
Removed almos all code from markdown/transform package.
f35f371
@svetlyak40wt
Some old functions were removed.
c8391c7
@svetlyak40wt
Renamed page2 to page.
e2c5453
@svetlyak40wt
Moved docstring related functions to 40ants-doc/docstring package.
807e83c
@svetlyak40wt
Moved parse-markdown function.
00977ce
@svetlyak40wt
Cleaned link.lisp file.
3c8b1e1
@svetlyak40wt
Removed variable *document-min-link-hash-length*.
ea1bce3
@svetlyak40wt
Updated qlfile.lock.
8ce0c37
@svetlyak40wt
Updated test files.
5a47991
@svetlyak40wt
Functions 40ANTS-DOC/BUILDER:UPDATE-ASDF-SYSTEM-DOCS and 40ANTS-DOC/B…
d9a5341 
…UILDER:RENDER-TO-FILES now accept WARN-ON-UNDOCUMENTED-PACKAGES argument.
@svetlyak40wt
Added CLEAN-URLS argument.
c8e3e30
@svetlyak40wt
Marked some variables as not supported yet.
08cf1ab
@svetlyak40wt
Fixes *document-link-code* variable effect.
f516e58
@svetlyak40wt
Added DOWNCASE-UPPERCASE-CODE argument instead of *DOCUMENT-DOWNCASE-…
7dcac81 
…UPPERCASE-CODE*
@svetlyak40wt
Updated test pages.
318901e
@svetlyak40wt
Added warnings on symbols, referenced like internals, using ::.
5e57f9d 
Also, now symbol names inside sections are rendered with respect to
section's package.
@svetlyak40wt
Fixed error in tests.
4831cc6
@svetlyak40wt
Allow to reference sections as internal symbols.
08ba607
@svetlyak40wt
Fixed all symbols, referenced as internal.
77f8fc6
@svetlyak40wt
Fixed one more reference to the find-source.
cd2031c
@svetlyak40wt
Added a section on rendering multiple formats.
ce5f7eb
@svetlyak40wt
Added reference to a changelog.
8adf24c
@svetlyak40wt
Shortened links and fixed code in tutorial section.
25b78dd
@svetlyak40wt svetlyak40wt merged commit d3304a4 into master Aug 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@svetlyak40wt @coveralls