apjanke / octave-tablicious

Table (relational, tabular data) implementation for GNU Octave
https://apjanke.github.io/octave-tablicious/
GNU General Public License v3.0
28 stars 11 forks source link

Functions in packages (namespaces) not showing up in generated doco? #120

Closed apjanke closed 5 months ago

apjanke commented 5 months ago

Package-qualified functions like the new tblish.sizeof aren't showing up in the generated doco, even though they're in the INDEX.

In tblish.sizeof:

## Copyright (C) 2019, 2023, 2024 Andrew Janke <floss@apjanke.net>
##
## This file is part of Tablicious.
##
[...]

## -*- texinfo -*-
## @node tblish.sizeof
## @deftypefn {Function} {@var{out} =} sizeof (@var{x})
##
## Approximate size of an array in bytes.

I see it in the "By Category" index:

image

But that link leads to:

image
apjanke commented 5 months ago

Oh, looks like they're getting an extra "tblish." prefix? Not showing up in the By Category index.

image

In the files:

[octave-tablicious] $ find doc -iname '*sizeof*'
doc/html/tblish_002etblish_002esizeof.html
doc/html/tblish_002esizeof.html
[octave-tablicious] $

tblish_002esizeof.html is the page that says "not documented". tblish_002etblish_002esizeof.html has real doco. If I open it directly, I see:

image
apjanke commented 5 months ago

Ahaaa - the problem was that the auto-namespacing in mktexi.pl could add a redundant namespace prefix if the namespace was already included in the item name inside the texinfo, and thus in the implied node name.

I switched it to not do auto-namespacing, and added explicit namespace qualifiers on all the items in namespaces, since that's how they need to be invoked in the code, so I think it should show up that way in the documentation, too.