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

Inconsistencies between readthedocs and circleci docs #68

Closed
choldgraf opened this issue Feb 20, 2020 · 4 comments
Closed

Inconsistencies between readthedocs and circleci docs #68

choldgraf opened this issue Feb 20, 2020 · 4 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation
Milestone

Comments

@choldgraf
Copy link
Member

There are some inconsistencies between RTD and Circle builds. For example:

In particular, note blocks are classed differently. The RTD docs class things as admonition while the CircleCI docs class things as alert

I think this is related to the pydata bootstrap theme re-classing (https://github.com/pandas-dev/pydata-bootstrap-sphinx-theme/blob/master/pandas_sphinx_theme/bootstrap_html_translator.py#L44). This is code that replaces common Sphinx classes with the respective bootstrap classes so that the CSS shows up.

For some reason, this replacement happens in CircleCI, but not in readthedocs...

@choldgraf choldgraf added the bug Something isn't working label Feb 20, 2020
@chrisjsewell chrisjsewell added the documentation Improvements or additions to documentation label Feb 20, 2020
@choldgraf
Copy link
Member Author

also opened up pydata/pydata-sphinx-theme#94 to track this

@choldgraf
Copy link
Member Author

choldgraf commented Feb 21, 2020

ah this might be our problem: pydata/pydata-sphinx-theme#94 (comment)

opened up readthedocs/readthedocs.org#6690 to discuss

@choldgraf
Copy link
Member Author

I believe that pydata/pydata-sphinx-theme#95 will fix our problem, let's find out once it's merged

@chrisjsewell
Copy link
Member

I believe that pandas-dev/pydata-bootstrap-sphinx-theme#95 will fix our problem, let's find out once it's merged

Yep that did it 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants