From 2e359f8aef0c1145f6c20be671d09271274a29e1 Mon Sep 17 00:00:00 2001 From: Jules Villard Date: Fri, 19 Feb 2021 09:57:27 -0800 Subject: [PATCH] [website] fix links to static resources Summary: Links to pages in static resources have been broken for a while it seems: Docusaurus generates a Page not Found error for them, then refreshing the URL loads the page properly... This is because of wrong routing from the Docusaurus Single-Page App. See https://github.com/facebook/docusaurus/issues/3309 A suggested workaround is to prepend `pathname://` in front of each link not managed by docusaurus. This makes the page open in a new tab, which is actually quite ok for our use cases: OCaml API docs and man pages. Reviewed By: skcho Differential Revision: D26544273 fbshipit-source-id: 2ed86ca4f --- website/docs/01-man-pages.md | 18 +++++++++--------- website/docs/04-absint-framework.md | 6 +++--- website/docs/04-internal-API.md | 2 +- .../version-0.17.0/01-man-pages.md | 16 ++++++++-------- .../version-0.17.0/04-internal-API.md | 2 +- .../version-1.0.0/01-man-pages.md | 18 +++++++++--------- .../version-1.0.0/04-absint-framework.md | 6 +++--- .../version-1.0.0/04-internal-API.md | 2 +- 8 files changed, 35 insertions(+), 35 deletions(-) diff --git a/website/docs/01-man-pages.md b/website/docs/01-man-pages.md index 022e1b337..e2b71683f 100644 --- a/website/docs/01-man-pages.md +++ b/website/docs/01-man-pages.md @@ -5,12 +5,12 @@ title: Infer Manuals Here are the man pages for all the infer commands: -- [infer](/man/next/infer.1.html) -- [infer analyze](/man/next/infer-analyze.1.html) -- [infer capture](/man/next/infer-capture.1.html) -- [infer compile](/man/next/infer-compile.1.html) -- [infer help](/man/next/infer-help.1.html) -- [infer explore](/man/next/infer-explore.1.html) -- [infer report](/man/next/infer-report.1.html) -- [infer reportdiff](/man/next/infer-reportdiff.1.html) -- [infer run](/man/next/infer-run.1.html) +- [infer](pathname:///man/next/infer.1.html) +- [infer analyze](pathname:///man/next/infer-analyze.1.html) +- [infer capture](pathname:///man/next/infer-capture.1.html) +- [infer compile](pathname:///man/next/infer-compile.1.html) +- [infer help](pathname:///man/next/infer-help.1.html) +- [infer explore](pathname:///man/next/infer-explore.1.html) +- [infer report](pathname:///man/next/infer-report.1.html) +- [infer reportdiff](pathname:///man/next/infer-reportdiff.1.html) +- [infer run](pathname:///man/next/infer-run.1.html) diff --git a/website/docs/04-absint-framework.md b/website/docs/04-absint-framework.md index d230c6936..ea50f67fb 100644 --- a/website/docs/04-absint-framework.md +++ b/website/docs/04-absint-framework.md @@ -97,7 +97,7 @@ and Useful analyses have output. Basic printing to stderr or stderr is good for debugging, but to report a programmer-readable error that is tied to a source code location, you'll want to use -[`Reporting.log_issue`](/odoc/next/infer/Absint/Reporting/index.html#val-log_issue). +[`Reporting.log_issue`](pathname:///odoc/next/infer/Absint/Reporting/index.html#val-log_issue). ## By example: interprocedural analysis @@ -165,5 +165,5 @@ That's it! We now have an interprocedural analysis. To go deeper, jump to the [lab exercise](https://github.com/facebook/infer/blob/master/infer/src/labs/README.md) and to the [API documentation](internal-API/), e.g. for the -[Absint](/odoc/next/infer/Absint.html) and -[IR](/odoc/next/infer/IR.html) modules. +[Absint](pathname:///odoc/next/infer/Absint.html) and +[IR](pathname:///odoc/next/infer/IR.html) modules. diff --git a/website/docs/04-internal-API.md b/website/docs/04-internal-API.md index 358663dff..efe5728af 100644 --- a/website/docs/04-internal-API.md +++ b/website/docs/04-internal-API.md @@ -3,6 +3,6 @@ id: internal-API title: Infer Internal OCaml Modules API --- -Browse the generated documentation for Infer's OCaml code [here](/odoc/next/infer/infer.html). +Browse the generated documentation for Infer's OCaml code [here](pathname:///odoc/next/infer/infer.html). You can also generate these pages from within an Infer repository with `make doc`. diff --git a/website/versioned_docs/version-0.17.0/01-man-pages.md b/website/versioned_docs/version-0.17.0/01-man-pages.md index cc79bc7fa..3f823a991 100644 --- a/website/versioned_docs/version-0.17.0/01-man-pages.md +++ b/website/versioned_docs/version-0.17.0/01-man-pages.md @@ -5,11 +5,11 @@ title: Infer Manuals Here are the man pages for all the infer commands: -- [infer](/man/0.17.0/infer.1.html) -- [infer analyze](/man/0.17.0/infer-analyze.1.html) -- [infer capture](/man/0.17.0/infer-capture.1.html) -- [infer compile](/man/0.17.0/infer-compile.1.html) -- [infer explore](/man/0.17.0/infer-explore.1.html) -- [infer report](/man/0.17.0/infer-report.1.html) -- [infer reportdiff](/man/0.17.0/infer-reportdiff.1.html) -- [infer run](/man/0.17.0/infer-run.1.html) +- [infer](pathname:///man/0.17.0/infer.1.html) +- [infer analyze](pathname:///man/0.17.0/infer-analyze.1.html) +- [infer capture](pathname:///man/0.17.0/infer-capture.1.html) +- [infer compile](pathname:///man/0.17.0/infer-compile.1.html) +- [infer explore](pathname:///man/0.17.0/infer-explore.1.html) +- [infer report](pathname:///man/0.17.0/infer-report.1.html) +- [infer reportdiff](pathname:///man/0.17.0/infer-reportdiff.1.html) +- [infer run](pathname:///man/0.17.0/infer-run.1.html) diff --git a/website/versioned_docs/version-0.17.0/04-internal-API.md b/website/versioned_docs/version-0.17.0/04-internal-API.md index c9964eee1..699a2216d 100644 --- a/website/versioned_docs/version-0.17.0/04-internal-API.md +++ b/website/versioned_docs/version-0.17.0/04-internal-API.md @@ -3,6 +3,6 @@ id: internal-API title: Infer Internal OCaml Modules API --- -Browse the generated documentation for Infer's OCaml code [here](/odoc/0.17.0/index.html). +Browse the generated documentation for Infer's OCaml code [here](pathname:///odoc/0.17.0/index.html). You can also generate these pages from within an Infer repository with `make doc`. diff --git a/website/versioned_docs/version-1.0.0/01-man-pages.md b/website/versioned_docs/version-1.0.0/01-man-pages.md index 8f6b4acba..ce139c46e 100644 --- a/website/versioned_docs/version-1.0.0/01-man-pages.md +++ b/website/versioned_docs/version-1.0.0/01-man-pages.md @@ -5,12 +5,12 @@ title: Infer Manuals Here are the man pages for all the infer commands: -- [infer](/man/1.0.0/infer.1.html) -- [infer analyze](/man/1.0.0/infer-analyze.1.html) -- [infer capture](/man/1.0.0/infer-capture.1.html) -- [infer compile](/man/1.0.0/infer-compile.1.html) -- [infer help](/man/1.0.0/infer-help.1.html) -- [infer explore](/man/1.0.0/infer-explore.1.html) -- [infer report](/man/1.0.0/infer-report.1.html) -- [infer reportdiff](/man/1.0.0/infer-reportdiff.1.html) -- [infer run](/man/1.0.0/infer-run.1.html) +- [infer](pathname:///man/1.0.0/infer.1.html) +- [infer analyze](pathname:///man/1.0.0/infer-analyze.1.html) +- [infer capture](pathname:///man/1.0.0/infer-capture.1.html) +- [infer compile](pathname:///man/1.0.0/infer-compile.1.html) +- [infer help](pathname:///man/1.0.0/infer-help.1.html) +- [infer explore](pathname:///man/1.0.0/infer-explore.1.html) +- [infer report](pathname:///man/1.0.0/infer-report.1.html) +- [infer reportdiff](pathname:///man/1.0.0/infer-reportdiff.1.html) +- [infer run](pathname:///man/1.0.0/infer-run.1.html) diff --git a/website/versioned_docs/version-1.0.0/04-absint-framework.md b/website/versioned_docs/version-1.0.0/04-absint-framework.md index 1f901ffeb..a9cfc62e0 100644 --- a/website/versioned_docs/version-1.0.0/04-absint-framework.md +++ b/website/versioned_docs/version-1.0.0/04-absint-framework.md @@ -97,7 +97,7 @@ and Useful analyses have output. Basic printing to stderr or stderr is good for debugging, but to report a programmer-readable error that is tied to a source code location, you'll want to use -[`Reporting.log_issue`](/odoc/1.0.0/infer/Absint/Reporting/index.html#val-log_issue). +[`Reporting.log_issue`](pathname:///odoc/1.0.0/infer/Absint/Reporting/index.html#val-log_issue). ## By example: interprocedural analysis @@ -165,5 +165,5 @@ That's it! We now have an interprocedural analysis. To go deeper, jump to the [lab exercise](https://github.com/facebook/infer/blob/master/infer/src/labs/README.md) and to the [API documentation](internal-API/), e.g. for the -[Absint](/odoc/1.0.0/infer/Absint.html) and -[IR](/odoc/1.0.0/infer/IR.html) modules. +[Absint](pathname:///odoc/1.0.0/infer/Absint.html) and +[IR](pathname:///odoc/1.0.0/infer/IR.html) modules. diff --git a/website/versioned_docs/version-1.0.0/04-internal-API.md b/website/versioned_docs/version-1.0.0/04-internal-API.md index 3988800b9..307b1c4f8 100644 --- a/website/versioned_docs/version-1.0.0/04-internal-API.md +++ b/website/versioned_docs/version-1.0.0/04-internal-API.md @@ -3,6 +3,6 @@ id: internal-API title: Infer Internal OCaml Modules API --- -Browse the generated documentation for Infer's OCaml code [here](/odoc/1.0.0/infer/infer.html). +Browse the generated documentation for Infer's OCaml code [here](pathname:///odoc/1.0.0/infer/infer.html). You can also generate these pages from within an Infer repository with `make doc`.