Some functions don't show up in the docs

szhorvat · 26 January 2020 17:59

Some functions which are explicitly included in the .xxml files do not show up in the generated documentation.

Example: igraph_dim_select in

igraph/igraph/blob/master/doc/embedding.xxml#L12


<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
                  "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY igraph "igraph">
]>


<chapter id="igraph-Embedding">
<title>Embedding of graphs</title>


<section><title>Functions</title>
<!-- doxrox-include igraph_adjacency_spectral_embedding -->
<!-- doxroc-include igraph_dim_select -->
</section>


</chapter>

If I add the missing , it also does not show up. @ntamas, have you any idea what is going wrong here?

szhorvat · 26 January 2020 18:27

There may have been some bad character that looks like ASCII but isn’t. Almost fixed, but need to deal with some XML errors.

EDIT: Fully fixed by re-typing it from scratch and fixing errors in the actual doc comment. It must have been some non-ASCII characters.

Topic		Replies	Views
trouble building the xml docs Usage	2	43	22 April 2025
Building docbook html from Mac Development	4	936	30 October 2022
Add sitewide search to igraph.org Site Feedback	6	629	31 January 2020
Dead link in documentation Usage Python	4	685	20 September 2021
Searchable docs Development	17	795	12 July 2020

Some functions don't show up in the docs

Related topics