Docs v3 #1281
Merged
Docs v3 #1281
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
panglesd
approved these changes
Jan 21, 2025
doc/odoc_for_authors.mld
Outdated
| @@ -15,6 +15,15 @@ To generate documentation for your project, you will almost always be using | |||
| 'drivers' of [odoc] at time of writing, each with their own strengths and | |||
| weaknesses: | |||
|
|
|||
| - {{!/odoc-driver/page-index}The reference driver} is the most up-to-date driver, | |||
| and incorporates all of the features of odoc. It is also used for the docs | |||
| published on ocaml.org. It does not feature fast rebuilds, nor keeping a | |||
There was a problem hiding this comment.
Not yet, should we wait for this to be true or not?
There was a problem hiding this comment.
hmm, yes, I'll weaken that a little bit.
| @@ -55,11 +55,6 @@ let compile ~output_dir ~input_file:file ~includes ~suppress_warnings ~parent_id | |||
| in | |||
| let cmd = cmd % "--parent-id" % Id.to_string parent_id in | |||
| let cmd = if suppress_warnings then cmd % "--suppress-warnings" else cmd in | |||
| let dirname = Id.to_fpath parent_id |> Fpath.filename in | |||
| let cmd = | |||
| if Fpath.filename file = "index.mld" then cmd % "--short-title" % dirname | |||
There was a problem hiding this comment.
The --short-title option is not used anymore but still defined. Shouldn't we completely remove it?
There was a problem hiding this comment.
No, because it will be used.
jonludlam
added
the
no changelog
panglesd
reviewed
Jan 21, 2025
Co-authored-by: Paul-Elliot Anglès d'Auriac <[email protected]>
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.
No description provided.