[odoc] fix doc generation, no need for public names

Summary:
All dune libraries in infer/src/ were declared with their own public
names, each one needing its own .opam file. There's no need for that:
they can all be part of the `infer` library by calling them `infer.Foo`.

One wrinkle: now we need to explicitly point at their .mld files in the
generated documentation.

Reviewed By: jberdine

Differential Revision: D20798914

fbshipit-source-id: 64b64261c

Makefile

@@ -851,7 +851,7 @@ doc: src_build_common
 # do not call the browser if we are publishing the docs
 ifeq ($(filter doc-publish,${MAKECMDGOALS}),)
 	$(QUIET)$(call silent_on_success,Opening in browser,\
-	browse $(SRC_DIR)/_build/default/_doc/_html/index.html)
+	browse $(INFER_DIR)/_build/default/_doc/_html/index.html)
 	$(QUIET)echo "Tip: you can generate the doc for all the opam dependencies of infer like this:"
 	$(QUIET)echo
 	$(QUIET)echo "  odig odoc # takes a while, run it only when the dependencies change"

infer/dune

@@ -2,4 +2,10 @@
 ;
 ; This source code is licensed under the MIT license found in the
 ; LICENSE file in the root directory of this source tree.
+
 (dirs src bin)
+
+(documentation
+ (package infer)
+ (mld_files :standard)
+)

infer/index.mld

@@ -0,0 +1,7 @@
+{1 Infer Libraries}
+
+- {{:infer.html}infer}: most of the modules: capture, analysis, integrations, ...
+- {{:IR.html}IR}: the intermediate language used by the analysis
+- {{:base.html}base}: configuration and utilities
+- {{:atd.html}atd}: auto-generated datatypes
+- {{:istd.html}}: additions to the Core standard library

infer/infer.mld

@@ -50,7 +50,7 @@ Tips & Tricks:
 {2 eradicate/ }
 Eradicate [@Nullable] Checker
 
-Eradicate is a type checker for [@Nullable] annotations for Java. The goal is to eradicate null pointer exceptions. See the online docs at {:http://fbinfer.com/docs/eradicate.html}.
+Eradicate is a type checker for [@Nullable] annotations for Java. The goal is to eradicate null pointer exceptions. See the online docs at {:http://fbinfer.com/docs/eradicate}.
 
 The main entry point is module {!module-InferModules.Eradicate}.
 

infer/src/IR/dune

@@ -5,14 +5,10 @@
 
 (library
  (name InferIR)
- (public_name InferIR)
+ (public_name infer.InferIR)
  (flags
   (:standard -open Core -open InferStdlib -open IStd -open InferGenerated
     -open InferBase))
  (libraries core zarith InferStdlib InferGenerated InferBase)
  (preprocess
   (pps ppx_compare)))
-
-(documentation
- (package InferIR)
- (mld_files index))

infer/src/Makefile

@@ -95,7 +95,7 @@ test: $(SRC_BUILD_COMMON) $(MAKEFILE_LIST)
 
 .PHONY: doc
 doc: $(SRC_BUILD_COMMON) $(MAKEFILE_LIST)
-	$(QUIET)$(DUNE_BUILD) @doc
+	$(QUIET)cd .. && $(DUNE_BUILD) @doc
 
 .PHONY: check
 check: src_build_common

infer/src/atd/dune

@@ -5,17 +5,13 @@
 
 (library
  (name InferGenerated)
- (public_name InferGenerated)
+ (public_name infer.InferGenerated)
  (flags
   (:standard -w -27-32-34-35-39))
  (libraries atdgen core)
  (preprocess
   (pps ppx_compare)))
 
-(documentation
- (package InferGenerated)
- (mld_files index))
-
 ; Rules below are boilerplatey, but this is benign and very easy to
 ; understand boilerplate.
 

infer/src/base/dune

@@ -5,14 +5,10 @@
 
 (library
  (name InferBase)
- (public_name InferBase)
+ (public_name infer.InferBase)
  (flags
   (:standard -open Core -open InferStdlib -open IStd -open InferGenerated))
  (libraries cmdliner core mtime.clock.os parmap re sqlite3 zip InferGenerated
    InferStdlib)
  (preprocess
   (pps ppx_compare ppx_enumerate)))
-
-(documentation
- (package InferBase)
- (mld_files index))

infer/src/base/dune.in

@@ -1,24 +0,0 @@
-(* -*- tuareg -*- *)
-(*
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *)
-(* NOTE: prepend dune.common to this file! *)
-
-;;
-Format.sprintf
-  {|
-(library
- (name InferBase)
- (public_name InferBase)
- (flags (:standard -open Core -open InferStdlib -open IStd -open InferGenerated))
- (libraries InferStdlib InferGenerated core)
- (preprocess (pps ppx_compare ppx_enumerate)))
-
-(documentation
- (package InferBase)
- (mld_files index))
-|}
-|> Jbuild_plugin.V1.send

infer/src/c_stubs/dune

@@ -5,7 +5,7 @@
 
 (library
  (name InferCStubs)
- (public_name InferCStubs)
+ (public_name infer.InferCStubs)
  (foreign_stubs
   (language c)
   (names fnv64_hash)))

infer/src/c_stubs/dune-project

@@ -1,2 +0,0 @@
-(lang dune 2.0)
-(name CStubs)

infer/src/dune.in

@@ -91,13 +91,6 @@ let main_lib_stanza =
     (String.concat " " infer_binaries)
 
 
-let docs_stanza = {|
-(documentation
- (package infer)
- (mld_files index)
-)
-|}
-
 let infer_exe_stanza =
   Format.sprintf
     {|
@@ -150,8 +143,7 @@ let flatten_sources_stanzas =
 
 (** The build stanzas to be passed to dune *)
 let stanzas =
-  env_stanza :: main_lib_stanza :: infer_exe_stanza :: infertop_stanza :: docs_stanza
-  :: clang_lexer_stanzas
+  (env_stanza :: main_lib_stanza :: infer_exe_stanza :: infertop_stanza :: clang_lexer_stanzas)
   @ topl_stanzas @ flatten_sources_stanzas
 
 

infer/src/istd/dune

@@ -5,13 +5,9 @@
 
 (library
  (name InferStdlib)
- (public_name InferStdlib)
+ (public_name infer.InferStdlib)
  (flags
   (:standard -open Core))
  (libraries ANSITerminal core str yojson)
  (preprocess
   (pps ppx_compare)))
-
-(documentation
- (package InferStdlib)
- (mld_files index))