Skip to content

Consider migrating the docs from Bootstrap to ReadTheDocs theme #80

Closed
@vitaut

Description

@vitaut

Advantages of the Bootstrap theme:

  1. Mobile friendliness
  2. Good default styles

Disadvantages of the Bootstrap theme:

  1. Conflicts of CSS classes between Bootstrap and Docutils/Sphinx (Bootstrap classes prefix twbs/bootstrap#1287)
  2. Primary use of navbar instead of sidebar navigation
  3. Inherits all the Bootstrap issues (cluttered non-semantic markup, heavy etc).

Since the main reason for using the Bootstrap theme was mobile friendliness, it might be easier just to use a mobile-friendly Sphinx theme such as ReadTheDocs instead of addressing the issues with Bootstrap.

Advantages of the ReadTheDocs theme:

  1. Mobile friendliness
  2. Sidebar navigation works out of the box
  3. Integration with ReadTheDocs
  4. Large user base

Disadvantages of the ReadTheDocs theme:

  1. Poor default styles, esp. for API
  2. Doesn't look good on a tablet (at least in vertical mode) - the sidebar is too wide. The stock Sphinx theme is actually better.
  3. Difficult to customize (issue 518)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions