search

mdhaber / scipy

Scipy library main repository
http://scipy.org/scipylib/
BSD 3-Clause "New" or "Revised" License
1 stars 5 forks source link

New distributions2 #109

Closed mdhaber closed 1 year ago

mdhaber commented 1 year ago

Attempt to render documentation

mdhaber commented 1 year ago

@tupui @melissawm I have a class A that defines documentation for method fu. Classes B and C inherit fu from A, but Sphinx is rendering separate html files for A.fu, B.fu, and C.fu. Tirth and I were wondering if you had any ideas about how to prevent this? We want the page for B and C to link to the methods of A.

Example: ContinuousDistribution.pdf (A.fu) Normal.pdf (B.fu) LogUniform.pdf (C.fu)

CC @tirthasheshpatel

tupui commented 1 year ago

I don't think you could have that with Sphinx as it would require some more JS to have a single html template and have the JS render it and change the class name.

What you can do though is to ask sphinx to not generate doc for some methods (I don't have the syntax or option on top of my head). This way you would only have the doc for A.fu, but not the rest.

mdhaber commented 1 year ago

I don't think you could have that with Sphinx as it would require some more JS to have a single html template and have the JS render it and change the class name.

It wouldn't really have to change the class name. I thought that B.fu would literally link to A.fu's documentation without trying to make it look like B.fu. After all, if B is a subclass of A, then an instance of B is an instance of A, so the A.fu documentation should suffice unless the method is overridden.