Commit f91fdf4
committed
Add support for advanced
Author: @ptaoussanis
This is an advanced option to help prevent any broken doc links
when upgrading a project's docs from single language to dual language.
In this case, :base-language can be set to the previous (single)
language for which doc links may already exist in the wild.
In detail, if cross-platform project then:
{:base-language nil} => ".clj", ".cljs" file extensions ; Default
{:base-language :clojure} => nil, ".cljs" file extensions
{:base-language :clojurescript} => ".clj", nil file extensions
For example:
Library Foo previously used {:language :clojure} (either because
it was Clojure only, or because of limitations in Codox).
Various links to Foo's Codox documentation now exist in the wild.
Foo's authors want to change to cross-platform, but don't
want to break pre-existing links in the wild.
In this case, Foo's authors can use the following opts:
{:language #{:clojure :clojurescript}
:base-language :clojure}
This will produce files like the following:
com.foolib.html ; For Clojure platform
com.foolib.cljs.html ; For ClojureScript platform
Any pre-existing links will successfully point to the same
(Clojure) docs they did previously.:base-language option1 parent f88c2d9 commit f91fdf4
1 file changed
+21
-12
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
147 | 147 | | |
148 | 148 | | |
149 | 149 | | |
150 | | - | |
151 | | - | |
152 | | - | |
153 | | - | |
154 | | - | |
155 | | - | |
156 | | - | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
157 | 163 | | |
158 | 164 | | |
159 | 165 | | |
160 | 166 | | |
161 | 167 | | |
162 | 168 | | |
163 | | - | |
| 169 | + | |
164 | 170 | | |
165 | 171 | | |
166 | 172 | | |
| |||
517 | 523 | | |
518 | 524 | | |
519 | 525 | | |
520 | | - | |
521 | | - | |
| 526 | + | |
| 527 | + | |
| 528 | + | |
| 529 | + | |
| 530 | + | |
522 | 531 | | |
523 | 532 | | |
524 | 533 | | |
| |||
527 | 536 | | |
528 | 537 | | |
529 | 538 | | |
530 | | - | |
| 539 | + | |
531 | 540 | | |
532 | 541 | | |
533 | 542 | | |
| |||
550 | 559 | | |
551 | 560 | | |
552 | 561 | | |
553 | | - | |
| 562 | + | |
554 | 563 | | |
555 | 564 | | |
556 | 565 | | |
| |||
0 commit comments