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

consider new theme and GHA for versioned docs #1282

Open
jGaboardi opened this issue Jul 13, 2023 · 9 comments
Open

consider new theme and GHA for versioned docs #1282

jGaboardi opened this issue Jul 13, 2023 · 9 comments
Assignees
Labels

Comments

@jGaboardi
Copy link
Member

Consider implementing the PyData Theme from sphinx.

Also check out PyAnsys

@jGaboardi jGaboardi added the Docs label Jul 13, 2023
@jGaboardi jGaboardi self-assigned this Jul 13, 2023
@martinfleis
Copy link
Member

I suggest moving this under pysal/pysal and have a discussion on switching the theme across the packages. And there may be better options than pydata-sphinx-theme, like book (used in xvec) or furo (used by xyzservices). I'd be eventually willing to switch momepy to the same one :).

@jGaboardi
Copy link
Member Author

I am very +1 on both suggestions. Just put the issue here so I wouldn't forget.

Think we should migrate to an Issue or Discussion over in pysal/pysal?

@martinfleis
Copy link
Member

Yeah. Since it is actionable and can be closed by a PR, an issue?

@jGaboardi jGaboardi transferred this issue from pysal/spaghetti Jul 13, 2023
@jGaboardi
Copy link
Member Author

Another possibility: diátaxis

@martinfleis
Copy link
Member

Here are those 3 themes mentioned above used on momepy's documentation.

Each can be also customised a bit so it may look slightly better/more fitting than on these examples where I just replaced the theme in the conf.py.

@jGaboardi
Copy link
Member Author

It's seems that none of those 3 momepy examples allow for switching the previous docs version. Is that something that needs to be turned on or probably I am simply missing something.

@jGaboardi
Copy link
Member Author

Also, looks like we need to update the copyright year over in momepy. I'll open ticket for that.

@martinfleis
Copy link
Member

It's seems that none of those 3 momepy examples allow for switching the previous docs version

I haven't done anything on that front, just wanted to showcase themes. It was not supposed to work, though pydata theme has a machinery for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants