ReadtheDocs formatting error on any class that inherits param.Parameterized

Param
1

Hi All,

I’m struggling to find the best place to post this question, as I’m not sure whether the problem lies with param or ReadTheDocs, but I’ll start here.

Whenever one of my classes inherits from param.Parameterized and I create documentation for it I get what looks like a mini param documentation after the class parameters and attributes but the formatting is plaintext.

image
image690×1022 38.7 KB

Any idea how to turn this behaviour off as it looks really bad when using the documentation.

Cheers :slight_smile:

2

Hi @grantty

Welcome to the community

I don’t know the cause or how to solve it. But one thing I note is that some of the output is due to “windows” I believe. At least I sometimes see this in my console on windows. And people tell me its a windows issue.

If in any way you can provide something easily reproducible like a minimum reproducible snippet of code or a small repository, then it might be easier for the community to help.

image
image859×696 110 KB

3

Hi Marc, thanks for the reply,

All my development is on ubuntu and it happens on both building the docs locally (ubuntu) as well as readthedocs building them when it’s uploaded to the repo.

The repo is public but it isn’t small, unfortunately. I’ll try and create an example.

4

Here’s a small example to reproduce the same output, requiring these 4 small files in a folder.

conf.py (548 Bytes) example.py (529 Bytes)

index.rst contains:

Welcome to Documentation!
========================================

.. autoclass:: example.Example
   :members: example_method

and finally Makefile contains:

SPHINXOPTS    ?=
SPHINXBUILD   ?= sphinx-build
SOURCEDIR     = .
BUILDDIR      = _build

help:
	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

%: Makefile
	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

It requires installing sphinx, instructions here.

Then simply run make html inside the directory and it will produce a _build/html folder where inside will be an index.html file that will show the following:

image
image758×721 36.5 KB

Let me know if you have any issues.

1 Like