Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Format readthedocs #166

Closed
jwaa opened this issue Apr 30, 2020 · 6 comments
Closed

Format readthedocs #166

jwaa opened this issue Apr 30, 2020 · 6 comments
Labels
documentation Improvements or additions to documentation request A request for a new feature

Comments

@jwaa
Copy link
Member

jwaa commented Apr 30, 2020

Is your feature request related to a problem? Please describe.
Given the completion of the documentation (see #165), the readthedocs pages should be reviewed on their formatting.

Describe the solution you would like
A nice and readable documentation structure that is consistent throughout.

Describe alternatives you have considered
N/A

Additional context
N/A

@jwaa jwaa added documentation Improvements or additions to documentation request A request for a new feature labels Apr 30, 2020
@jwaa jwaa added this to the Release v1.1.0 milestone Apr 30, 2020
@thaije
Copy link
Collaborator

thaije commented May 8, 2020

The documentation was completely broken, because of the renaming and reordering of our files. The documentation was still looking for matrxs and other non-existent files and folders. This has been fixed now.

Writing down for future reference:
See for example this page. These classes were not clickable, because they referred to non-existent files.

I also discovered a peculiarity with the Sphinx documentation:
See for example this page. The individual methods of the class are not clickable, if the class itself does not have a short description.

Thus, the method of the following class is not clickable, and will thus not show the detailed documentation of the class' methods:

Class Test():

def method1(self):
    """ All methods properly documented
    ....
    """

This will also not work:

Class Test():
"""
A wonderful class description on the second line.
"""
def method1(self):
    """ Properly documented 
    ....
    """

This does work:

Class Test():
""" A wonderful class description on the first line. 
More detailed explanation here.
"""
def method1(self):
    """ Properly documented 
    ....
    """

@thaije
Copy link
Collaborator

thaije commented May 8, 2020

@jwaa Nice work with the documentation :) Pages like the ones for the Move action look great

@jwaa
Copy link
Member Author

jwaa commented Jun 22, 2020

@thaije Do you have the time (and hours) to work on this issue for the next release?

@thaije
Copy link
Collaborator

thaije commented Jun 27, 2020

@jwaa I do have some hours, however I am also tight on time coming weeks. My priority for now is fixing #154 , #182, #179. After those are done I can take a look at this, however I don't have a guarantee that it will be next week.

@jwaa
Copy link
Member Author

jwaa commented Jun 30, 2020

Then I move this issue to the milestone of v1.2.0

@thaije
Copy link
Collaborator

thaije commented Feb 5, 2021

Done with commit 42a91fa

@thaije thaije closed this as completed Feb 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation request A request for a new feature
Projects
None yet
Development

No branches or pull requests

2 participants