fossasia / sphinx_fossasia_theme Goto Github PK

Update meta viewport tag to render website on mobile devices.
Link: https://www.w3schools.com/css/css_rwd_viewport.asp

Current Outcome	Expected Outcome

The images rendered using the theme is spreading out of the mobile view.

Screenshot

Headerlinks are permanently visible beside the headers in docs. Such a behaviour is not desirable and in most of the themes, they are shown only on hover.

Description

Currently setup.py uses sphinx.html_themes entry point. It was introduced with sphinx 1.6. Before that sphinx_themes entry point was used but has been deprecated now. Thus our theme fails to work with the sphinx version < 1.6. setup.py should be modified to handle this case depending on sphinx version.

See #1 (review) for details

Description

Since it was decided that we will be inhering the basic theme and extend that, we can now update with structuring the layout using bootstrap components.

Bootstrap library will be used because it is highly responsive and also as the template for FOSSASIA's main website and other children web site's are created using Bootstrap.

Parent issue: #3

In travis, if language is python, The script section is necessary otherwise travis considers the build to be failing.

Since we don't execute any script, a blank echo should be fine.

Quoting @pri22296 from the official Gitter channel of yaydoc

Regarding sphinx_fossasia_theme, would it be helpful if we setup autodeployment to PyPI on each tagged commit from travis?
we'll set it up so that deploy only happens if the commit being merged has a git tag.

Each cell should have some padding otherwise the resulting table does not look pretty

The new FOSSASIA Address in Singapore is:
12 Eu Tong Sen Street #8-169 Singapore 059819
Please update it accordingly.

In reference to issue:
fossasia/labs.fossasia.org#407

Description

Add a base templating HTML structure for the theme similar to Sphinx's built in base theme.
Without inheriting any theme and using structure same as that used by the base Sphinx theme will be a good learning curve and will help to extend it as per our needs

Update: After discussion, it is decided that we will instead inherit from the basic theme. As @pri22296 pointed out, From the sphinx docs:

The inherit setting gives the name of a “base theme”, or none. The base theme will be used to locate missing templates (most themes will not have to supply most templates if they use basic as the base theme), its options will be inherited, and all of its static files will be used as well.

Parent issue: #3

The link to the FOSSASIA LinkedIn group is broken/outdated, have pushed relevant PR to fix this

When we attempt to perform a search in a project with sphinx_fossasia_theme, it doesn't work.

Console output:

This repository was created following discussion in fossasia/yaydoc#2 and in the public gitter channel of yaydoc. It was decided that a separate repository will exist (in contrast to a subdirectory that existed in Yaydoc's repository) FOSSASIA's project.

This issue will exist as a parent issue with various updates to the theme as its children.

• Add a base templating HTML structure #4
• Integrate a protype bootstrap layout for the theme #5
• Update theme with Header and Footer #8
• Update the theme adding Left sidebar with Smooth Scrolling #9

Currently, the links are hard coded in the theme. Instead of that it would be desirable if users have an option to override the urls

http://yaydoc.herokuapp.com/preview/[email protected]/12602299-7367-470c-8da6-eb0fb6acc06f_preview/
customize the css to render the image properly

Update the theme by changing header and footer and make them look similar to FOSSASIA's original theme

Updating the theme adding a Left sidebar providing Bootstrap's scrollspy https://www.w3schools.com/bootstrap/bootstrap_ref_js_scrollspy.asp