Skip to content

Test new config for documentation - #453

Merged
GamelinAl merged 1 commit into
mainfrom
447-docs-rendering
Sep 24, 2026
Merged

GamelinAl merged 1 commit into
mainfrom
447-docs-rendering

Conversation

@GamelinAl

Copy link
Copy Markdown
Member

My test to solve #447

@TeresiaOlsson

Copy link
Copy Markdown
Member

Just so I have understood the solution correctly:

  • Attributes, properties and methods should have their own docstring.

  • Parameters should be in the class docstring and not in the __init__ docstring since the __init__ docstring is ignored in the docs.

  • And then you have customized the conf and css so it takes the output generated by napoleon and puts everything together so we get the format we want for both the readthedocs and help?

@GamelinAl

Copy link
Copy Markdown
Member Author
  • Attributes, properties and methods should have their own docstring.
  • Parameters should be in the class docstring and not in the __init__ docstring since the __init__ docstring is ignored in the docs.
  • And then you have customized the conf and css so it takes the output generated by napoleon and puts everything together so we get the format we want for both the readthedocs and help?

Yes to all 3 but only RTD is changed here. The help just print the class docstring which is already in the good format

@TeresiaOlsson

Copy link
Copy Markdown
Member

After it has been merged in I will put the same in the copier template and apply it to the other repositories so they all follow the same principles for the documentation.

@GamelinAl
GamelinAl merged commit fc06a59 into main Sep 24, 2026
3 checks passed
@GamelinAl
GamelinAl deleted the 447-docs-rendering branch September 24, 2026 07:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants