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

weird cascading references in docs #303

Open
jGaboardi opened this issue Nov 12, 2022 · 3 comments
Open

weird cascading references in docs #303

jGaboardi opened this issue Nov 12, 2022 · 3 comments
Assignees

Comments

@jGaboardi
Copy link
Member

In the References section of the spopt doc site, when a reference occupies a single line the subsequent reference is indented. This leads to a cascading effect that is only broken when a reference is more than one line long. I have not been able to determine why this is happening or a solution for it, but my hypothesis is that it has something to do with a setting in pysal-styles.css. An example of this can be seen in the References section of the spopt doc site, and from the screenshot below:

Screenshot 2022-11-12 at 11 51 33 AM

Another example can be seen in the spaghetti docs. Any assistance on debugging this would be greatly appreciated. I have tried searching SO and the like, but I don't seem to be using the correct search terms...

@weikang9009 @knaaptime @sjsrey

@weikang9009
Copy link
Member

@jGaboardi The issue should be related to sphinx and sphinxcontrib-bibtex which is used for BibTeX style citations with Sphinx. I installed an older version of sphinx (V4.2.0) and reran the doc generation - the cascading disappeared. Not sure how to fix the cascading when newer versions of sphinx are used though.

@jGaboardi
Copy link
Member Author

jGaboardi commented Nov 15, 2022

Good catch, @weikang9009! Can confirm that sphinx==4.5.0 seems to the latest version where the cascading is not present. Still no idea what is causing the cascading though. Will try to investigate further before opening an issue over there. Should pin sphinx==4.5.0 in the meantime.

jGaboardi added a commit to jGaboardi/spopt that referenced this issue Nov 15, 2022
@jGaboardi
Copy link
Member Author

The css adjustment added in pysal/spahgetti#688 "fixes" this strange formatting:
Screenshot 2022-11-26 at 1 36 47 PM

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

No branches or pull requests

2 participants