WEEK 11: Resolving the Footer Issue and Addressing Sphinx Warnings#
Hello everyone,
welcome to the update for Week 11 of my Google Summer of Code (GSoC) 2024 journey. This week, I focused on finalizing the footer issue on the FURY website and tackling some Sphinx warnings related to attribute and property naming conflicts. Here’s a detailed look at what I accomplished and the challenges faced.
Fixing the Footer Issue#
In the previous week, I identified the root cause of the footer deformation. The problem arose when hovering over elements, which caused their size to increase, thereby affecting the padding of their container and subsequently the entire footer layout. To illustrate the issue and the resolution, I have included the following videos:
Before Fixing the Footer Issue: Video demonstrating the footer deformation before the fix.
After Fixing the Footer Issue: Video showing the footer after applying the fix.
To address this, I experimented with different approaches. Initially, I tried adjusting the font-size of the elements on hover by making them bold instead. This resolved the deformation issue but did not align with the design specifications of the homepage footer.
After reconsidering, I added some properties to the .class-columns in the styles.css file to better adapt the footer style and prevent any layout issues. This approach aimed to maintain the design integrity while addressing the layout problem effectively.
Handling Sphinx Warnings#
In addition to fixing the footer, I worked on resolving warnings caused by Sphinx due to naming conflicts between attributes and properties. To mitigate these warnings, I initially added :no-index: directives in the .rst files for functions and classes to prevent indexing issues.
However, during our weekly meeting with my mentor Serge Koudoro, it became clear that this solution might hinder the indexing and referencing of functions, modules, and classes on the FURY site and the web. Therefore, I need to re-evaluate the issue and find a more suitable solution that ensures proper indexing while addressing the warnings.
Did I Get Stuck Anywhere ?#
While addressing the Sphinx warnings, I encountered some challenges related to the naming conflicts between attributes and properties. The warnings were triggered by the use of the same name for both an attribute and a property in the codebase. This conflict led to Sphinx warnings, which I am currently working to resolve. The complexity of this issue requires a more in-depth analysis to develop an appropriate solution that aligns with the project’s requirements and Sphinx guidelines.
Acknowledgements#
I am deeply grateful to my peers Iñigo Tellaetxe Elorriaga, Robin Roy, Kaustav Deka for their continuous support and insightful suggestions. Special thanks to my mentor, Serge Koudoro , whose expertise and guidance have been invaluable in navigating these technical challenges.
What’s Next ?#
For the upcoming week, I plan to:
Delve deeper into the Sphinx warnings related to attribute and property naming conflicts to develop a more appropriate solution.
Continue to refine the footer styling to ensure it meets design specifications while maintaining functionality.
Start writing my GSOC’2024 final report.
Thank you for following my progress. I look forward to sharing further updates and solutions in the coming weeks!