Merge Sherlodoc #1263
Merged
Merge Sherlodoc #1263
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WIP support of typedecl
Co-authored-by: panglesd <[email protected]>
Break www, so its disabled. Co-authored-by: panglesd <[email protected]>
Format for previous commit A bit of cleanup
remove weird warnings
The path relative to the project root makes sherlodoc impossible to vendor. Use a relative path instead.
"Fewer conversions between Names and strings"
"Overhaul of module-type-of and shadowing"
"Remove core types and exceptions from identifiers"
Several changes: - Entries are now defined in the `odoc_index` library, - Entries can have new kinds (pages, source, ...) - Indexes have the form of "skeletons of entries", that can be folded. - Indexes can be created by odoc with the `odoc compile-index` command, and then consumed by sherlodoc. These changes come from: - ocaml#1228 - ocaml#1232 - ocaml#1233 - ocaml#1244 - ocaml#1250 - ocaml#1251
This function was used only in sherlodoc, it makes sense to be here.
In particular, odoc 3 fixed a bug where "hidden" modules were still indexed. This is why e.g. `Base.StringLabels` is removed from the tests output.
Odoc 3 also fixed the way extension constructor are handled. Before, a "type" would be added, with ID the first constructor, making things rather strange from the user eg as in the (now fixed) example: ``` type Main.MyExtension ``` displayed for ``` type extensible_type += MyExtension ``` This is now fixed. A test for the definition of the extensible type is also added.
All of sherlodoc except for the website will be merged into the Odoc repository.
This will make maintaining both Odoc and Sherlodoc easier. Sherlodoc's website is not included and is intended to be maintained separately.
Closed
This is useful for running Odoc's tests alone, especially on < 4.08
|
It seems the "installing the dependencies" step should include sherlodoc's one, otherwise when installing sherlodoc's dependencies, opam installs odoc from opam-repository... |
This is needed to be able to run Sherlodoc's and Odoc's tests separately, for example in CI on in Opam.
Julow
force-pushed
the
merge-sherlodoc
branch
from
c22a578 to
085a9b5
Compare
These libraries need to be attached to a package with '(package odoc)'. This has the side effect of making the library installable (under the __private__ namespace) and promote test dependencies into build dependencies. This works around that.
Julow
force-pushed
the
merge-sherlodoc
branch
2 times, most recently
from
812ad71 to
8b484be
Compare
|
Benchmark CI is failing but it is not checking anything, that's just a infra issue, so it's not an issue for us now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This replaces #1259 and #1207
Sherlodoc will now be maintained as part of Odoc, except for its website. The entire history of Sherlodoc is kept for proper attribution using git subtree but the code is not intended to be extracted again. It is based on https://github.com/Julow/sherlodoc/tree/odoc3-merge
Sherlodoc will be released at the same time as Odoc with the same version numbers.