Package: editorial-sphinx-theme
Editorial is a theme for Sphinx, focused to facilitate the reading of the documentation to allow to use the entire
width of the screen, your design is responsive and adapts to any deviceLive example of this theme can be seen on:This template is based on Editorial by HTML5 UP (html5up.net), just made the changes needed to use it at the Sphinx.FeaturesEasy installation, does not make any extra settingsClean and simple designResponsive, adaptable from mobile devices to PCHide sidebar with one clickIntegrated and optional support for Google AnalyticsInstallationVia packageDownload the package or add it to your requirements.txt file:$pipinstalleditorial_sphinx_themeIn yourconf.pyfile:importeditorial_sphinx_themehtml_theme="editorial_sphinx_theme"html_theme_path=[editorial_sphinx_theme.get_html_theme_path()]Via git or downloadYou can install it directly from the Git repository, keep in mind that this will download the last changes made that
may not be stable and lead to failures. For sites in production try to use the version available in PyPi.There are two main branches ‘master’ with stable code and ‘develop’ with the latest modifications made.Symlink or subtree the editorial_sphinx_theme/editorial_sphinx_theme repository into your documentation at
docs/_themes/editorial_sphinx_theme then add the following two settings to your Sphinx conf.py file:Branchmasterpipinstall-egit+https://gitlab.com/opb/editorial-sphinx-theme.git@master#egg=editorial_sphinx_themeBranchdeveloppipinstall-egit+https://gitlab.com/opb/editorial-sphinx-theme.git@develop#egg=editorial_sphinx_themehtml_theme="editorial_sphinx_theme"html_theme_path=["_themes",]OptionsBasicBasic tools or functionsscroll_to_topInclude a button in the lower right corner to return to the top of the page.prev_next_buttons_bottomNavigation buttons at the end of the page, to go to the previous and next page.prev_next_buttons_sidebarNavigation buttons at the end of the sidebar, to go to the previous and next page.Repo infoInformation related to the used repositoryrepo_nameName of the repository service, for example GitLab. This name will be displayed in some parts of the page.repo_urlRepository address, for example:https://gitlab.com/opb/editorial-sphinx-themeGoogle Analytics [Optional]analytics_idThis indicates the Google Analytics ID used by this service, if you do not pass any value the javascript script
will not load on the page. The value must have the format “UA-XXXXX-Y”.analytics_asyncThis option indicates which version of the Google Analytics script to use, for more information in your websitehttps://developers.google.com/analytics/devguides/collection/analyticsjs/#alternative_async_tracking_snippetSocial links [Optional]Add in the header a series of links to different social networks, they don’t need individual explanation. It is enough
to indicate the url of the social network to activate itAvailable: github, bitbucket, gitlab, other_git, twitter, facebookFork Me Ribbon [Optional]You can enable the use of a ribbon in a corner of the page, with the legend “Fork me on <repo_name>” and the
destination url is the repository specified in the ‘repo_url’The options that you can use are as follows:forkme_ribbonIt enables the use, only loaded if it is equal to ‘True’.forkme_alignmentWhere shown, take the following locations: left-top, right-top, left-bottom, right-bottomforkme_fixedIf you pass ‘True’ to this option, the ribbon will be shown with the CSS property fixed, and as we scroll on the
page will continue showing in the same corner.How To ContributeCheck for open issues or open a fresh issue to start a discussion around a feature idea or a bug.Fork the repository on GitHub to start making your changes, preferably create a branch to dump these changes.Run or write tests to make sure everything works correctly.Send a pull request when you have finishedLicenseThis template is distributed under the GNU General Public License v3 (GPLv3) license, for more information see the file LICENSE.