Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
A
asdf
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
16
Issues
16
List
Boards
Labels
Service Desk
Milestones
Merge Requests
8
Merge Requests
8
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Incidents
Environments
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
asdf
asdf
Commits
b91cc03b
Commit
b91cc03b
authored
Aug 17, 2018
by
Francois-Rene Rideau
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Some cleanup and updates for the new UIOP manual
parent
e2bbb82d
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
22 additions
and
7 deletions
+22
-7
.gitignore
.gitignore
+5
-0
uiop/README.md
uiop/README.md
+10
-5
uiop/doc/template.texinfo
uiop/doc/template.texinfo
+7
-2
No files found.
.gitignore
View file @
b91cc03b
...
...
@@ -27,6 +27,11 @@ doc/version.texinfo
doc/*.log
*.tmp
uiop/doc/uiop.html
uiop/doc/uiop.info
uiop/doc/uiop.pdf
uiop/doc/uiop.texinfo
LICENSE
README.html
tmp/
...
...
uiop/README.md
View file @
b91cc03b
...
...
@@ -106,22 +106,27 @@ Each file starts with a package definition form that lists the exported symbols.
All the exported functions, macros and variables ought to have proper docstrings.
If not, then it's a legitimate bug that we invite you to report.
Maybe some automated tool will extract all that information and
You can extract a manual from the docstrings
by running
`make`
in the directory
`uiop/doc`
.
Other automated tools may hopefully extract all that information and
make a webpage from it, at which point it would be nice to insert a link here.
But many tools fail to extract useful data.
One tool with which you can extract all the documentation is HEΛP.
At this time, the interface is not great: it isn't obvious at all that you can indeed
use a scrollbar on the right of the top left side panel to navigate the many packages;
once you click on the package you're interested in, you can see its defined symbols:
<http://bimib.disco.unimib.it/people/Marco.Antoniotti/Projects/CL/HELAMBDAP/tests/asdf-uiop/docs/html/dictionary/dictionary.html>
*
<http://bimib.disco.unimib.it/people/Marco.Antoniotti/Projects/CL/HELAMBDAP/tests/asdf-uiop/docs/html/dictionary/dictionary.html>
The next version of
[
Declt
](
https://www.lrde.epita.fr/~didier/software/lisp/misc.php#declt
)
and through it of QuickRef will support extracting the documentation from UIOP:
<https://quickref.common-lisp.net/>
Another automated documentation tool is quickdocs, but unhappily, at the time of this writing,
it only extracts information from the first package
(see
[
bug #24
](
https://github.com/fukamachi/quickdocs/issues/24
)
):
*
<http://quickdocs.org/uiop/api>
<http://quickdocs.org/uiop/api>
Help wanted extracting working documentation from UIOP's docstrings.
...
...
uiop/doc/template.texinfo
View file @
b91cc03b
...
...
@@ -90,8 +90,13 @@ abstract over discrepancies between implementations, between operating
systems, and between what the standard provides and what programmers
actually need, to write portable Common Lisp programs.
It is organized by topic in many packages, all of which are available
in a single package @code
{
uiop
}
.
It is organized by topic in many files, each of which defines its own package
according to its topic: e.g @file
{
pathname.lisp
}
will define package @code
{
uiop/pathname
}
and contain utilities related to
the handling of pathname objects.
All exported symbols are reexported in a convenience package @code
{
uiop
}
,
except for those from @code
{
uiop/common-lisp
}
.
We recommend package @code
{
uiop
}
be used to access all the symbols.
The following API reference is auto-generated from the docstrings in
the code. The chapters are arranged in dependency order.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment