-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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.
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
documentation: configuration switch for an odoc documentation mode #9997
Merged
Merged
Changes from 15 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
5e3249b
documentation: add an odoc configuration switch
Octachron e852258
update Changes
Octachron 0cff531
fix ocamldoc html options
Octachron 9b3435d
api_docgen makefiles: replace setup target
Octachron 46cea52
odoc configuration option renamed to --with-odoc
Octachron 8764836
review: replace witness by stamp
Octachron 1fccef7
review: prettier api_docgen Makefiles
Octachron 38cb20a
review: remove setup
Octachron 2521b3c
review: use build directory uniformly
Octachron f99ae6e
review: documentation_mode -> documentation_tool
Octachron 29952bd
review: basic documentation for odoc Makefile
Octachron 6b7b7b5
manual: fix odoc reference to stdlib modules
Octachron d8e4790
review: move apidocgen/.gitignore to .gitignore
Octachron 24ec4ae
review: configuration
Octachron 9f44a3a
odoc: Adapt latex preamble to upstream change
Octachron befdf1e
changes: add reviewers
Octachron File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
#************************************************************************** | ||
#* * | ||
#* OCaml * | ||
#* * | ||
#* Florian Angeletti, projet Cambium, Inria Paris * | ||
#* * | ||
#* Copyright 2020 Institut National de Recherche en Informatique et * | ||
#* en Automatique. * | ||
#* * | ||
#* All rights reserved. This file is distributed under the terms of * | ||
#* the GNU Lesser General Public License version 2.1, with the * | ||
#* special exception on linking described in the file LICENSE. * | ||
#* * | ||
#************************************************************************** | ||
ROOTDIR = .. | ||
DOCGEN= $(ROOTDIR)/api_docgen | ||
|
||
-include $(ROOTDIR)/stdlib/StdlibModules | ||
include $(ROOTDIR)/Makefile.common | ||
include $(ROOTDIR)/Makefile.best_binaries | ||
include $(DOCGEN)/Makefile.docfiles | ||
|
||
DOC_COMPILERLIBS_DIRS= $(addprefix $(ROOTDIR)/,\ | ||
parsing utils typing bytecomp driver file_formats lambda) | ||
|
||
DOC_STDLIB_DIRS = $(addprefix $(ROOTDIR)/, stdlib \ | ||
otherlibs/str otherlibs/$(UNIXLIB) otherlibs/dynlink \ | ||
otherlibs/systhreads) | ||
|
||
.PHONY: all | ||
all: html pdf man | ||
|
||
DIRS = $(addprefix build/,libref compilerlibref man latex texi \ | ||
html html/libref html/compilerlibref) | ||
|
||
$(DIRS): | ||
$(MKDIR) $@ | ||
|
||
pdf: build/latex/alldoc.pdf | ||
latex: | ||
man: | ||
html: | ||
build/latex/alldoc.pdf: build/latex/stdlib_input.tex \ | ||
build/latex/compilerlibs_input.tex | build/latex/ifocamldoc.tex | ||
|
||
$(DOCGEN)/build/Compiler_libs.mld: $(DOCGEN)/Compiler_libs.pre.mld | ||
cp $< $@ && echo "{!modules:$(compilerlibref_C)}" >> $@ | ||
|
||
build/latex/ifocamldoc.tex: $(ROOTDIR)/Makefile.config | build/latex | ||
|
||
build/latex/alldoc.tex:$(DOCGEN)/alldoc.tex | build/latex | ||
cp $< $@ | ||
|
||
$(compilerlibref_TEXT:%=build/%.mld) $(libref_TEXT:%=build/%.mld): \ | ||
build/%.mld:$(DOCGEN)/%.mld | ||
cp $< $@ |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
? has to be instantiated here