ocamlpro / digodoc Goto Github PK
View Code? Open in Web Editor NEWDig into an opam switch for doc
License: Other
Dig into an opam switch for doc
License: Other
Some unsuspected crash has occured when mapping modules to their respective package directory.
Indeed some modules appear in subdirectories of that package (.private/
for example) and there mapping to that package is erroneous, said module being mapped the package dir, instead of, to keep previous example, .private
.
We have noticed small discrepancies between our expectations and the reality of some .changes
files under .opam_switch/install
of the opam config subtree.
This issue and #51 are correlated
Consider revisiting the overall esthetic and interface of generated doc pages.
make it look even prettier, coloring, background and whatnot
improve interfaces for a clearer, properly better user experience
It seems that type indexation makes some extra indexation steps that weren't envisaged:
(#in_obj_channel)
TYPE_ABSTRACT
in_obj_channel
This is an indexation entry for class in_obj_channel within moduleCsv inside package csv.
2. Indexation of corresponding class artifacts (values and methods)
opam: unknown command `depext'.
Usage: opam COMMAND ...
Try `opam --help' for more information.
Error: Process completed with exit code 2.
The packages you requested declare the following system dependencies. Please make sure they are installed before retrying:
gmp system:pkgconf
This would allow prevention of errors for a given module that has different subdirectories hiding a set of extensions.
see #60 (comment)
Module should be correctly associated to a package inside in_packs input.
#50 has revealed the need for a patching of relative links in generated markdown .html
files.
Consider extending the list of supported formats in the source tab with the following:
.md
filesJPEG
/PNG
/...).c
and .h
filesWhich are all rendered in a raw manner, for now.
It seems that cma-only libraries are ignored.
For instance, the OPAM package num installs three METAs :
The generated documentation for the OPAM package correctly mentions the three METAs, but only mentions the nums library.
Currently, the index is generated during the same pass as other pages. So, there is no way to merge package documentations coming from multiple switches. Instead, we should save the package documentations first, with enough information for a second, independent, pass to generate the 4 indexes.
Note that, though it will be easy to regenerate the indexes for OPAM., LIBRARY. and META., only independent modules have a MODULE. entry. So, we need to find another solution for modules that are included in libraries.
HTML code found in Markdown files isn't patched when generating sources and fixing static links.
Example:
Alcotest README.md file
### Examples
A simple example (taken from `examples/simple.ml`):
<p align="center"><img src="./.meta/ok.png" width="65%"></p>
This static link won't be patched and rendered in digodoc's Sources tab
Embedded modules are treated sometimes incorrectly and with additional __
. This implies redundant module page with same __
at the end of the module name. That should be analysed and fixed.
While clicking on "Update filters" button on the Advanced Search page, previously used filters should be opened by default instead of entry filters.
It seems these files are currently not rendered. That's a problem for my libraries which often have such files.
Also it would be nice to honour the odig
convention which allows packages to customize part of the package page landing page via the index.mld
file of the package. In my packages these files also have important bits for end-users (see e.g. odig's brr's package page).
The ocamlbuildlib.cmxa library uses signatures.mli, according to its source files, however ocamlobjinfo never lists this dependency. The .cmi and .cmti files for signatures are also present.
I don't know if this is related, but the Signatures interface only appears in include statements.
Add local search possibility within module pages, when modules will be organized better (without redundant __
as desribed here)
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.