mathematica-BTools icon indicating copy to clipboard operation
mathematica-BTools copied to clipboard

DocGen: CellContext of documentation files

Open kubaPod opened this issue 7 years ago • 1 comments

A small suggestion for DocGen family.

Since the target group are third party packages maybe generated symbols etc. notebooks should have CellContext -> Notebook or even Global` , though Notebook will be better.

The reason is Needs["myPackage`"] in an intialization cell does not do much since every cell group has separate $ContextPath. One still needs to use full names or change CellContext themself, which will be confusing for newbies.

kubaPod avatar Jun 19 '18 12:06 kubaPod

@kubaPod good point. I haven't been setting anything outside of what the stylesheet does/is necessary to get the right functionality. I probably should add this if I'm going to include that Needs line. In the meantime from the version on the paclet now server and going forward you can use DocGen["SymbolPage", ..., CellContext->Notebook] to get this, even with the "Notebook" method.

b3m2a1 avatar Jun 19 '18 18:06 b3m2a1