No more need of ABlog
This commit is contained in:
parent
c06565b495
commit
350f7d492c
GPG key ID:
ABBB2CAC6855599F
19 changed files with 110 additions and 82 deletions
8
CHANGES
8
CHANGES
|
|
@ -2,6 +2,14 @@
|
|||
Changes
|
||||
=======
|
||||
|
||||
1.0.3 (*2020-05-31*)
|
||||
====================
|
||||
|
||||
- ABlog is no more needed to build simple site
|
||||
- Fix some futurewarning
|
||||
- Fix documentation
|
||||
- Fix demo site
|
||||
|
||||
1.0.2 (*2020-05-27*)
|
||||
====================
|
||||
|
||||
|
|
|
|||
16
demo/conf.py
16
demo/conf.py
|
|
@ -18,8 +18,8 @@
|
|||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'demo'
|
||||
copyright = '2019, Eduardo'
|
||||
author = 'Eduardo'
|
||||
copyright = '2020, kujiu'
|
||||
author = 'Kujiu'
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = '0.1'
|
||||
|
|
@ -35,7 +35,6 @@ master_doc = 'source/index'
|
|||
extensions = [
|
||||
'sphinx.ext.mathjax',
|
||||
'sphinx.ext.autodoc',
|
||||
'ablog',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
|
|
@ -53,6 +52,17 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'nervproject'
|
||||
html_theme_options = {
|
||||
"logoalt": project,
|
||||
"social": [
|
||||
],
|
||||
"license": {
|
||||
'type': 'CC',
|
||||
'subtype': 'BY-SA',
|
||||
'version': '4.0',
|
||||
'url': 'https://creativecommons.org/licenses/by-sa/4.0/legalcode'
|
||||
}
|
||||
}
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ Python
|
|||
autofunction
|
||||
------------
|
||||
|
||||
.. autofunction:: sphinx_press_theme.add_toctree_data
|
||||
.. autofunction:: sphinx_nervproject_theme.add_toctree_data
|
||||
|
||||
autoclass
|
||||
---------
|
||||
|
|
|
|||
|
|
@ -2,16 +2,13 @@
|
|||
About
|
||||
=====
|
||||
|
||||
Sphinx Press is a modern responsive theme for python's
|
||||
`Sphinx docs <http://www.sphinx-doc.org>`_.
|
||||
A modern responsive theme for python's `Sphinx <http://www.sphinx-doc.org>`_ documentation generator based on
|
||||
sphinx_press_theme and ablog.
|
||||
|
||||
|
||||
This theme is based on `VuePress <https://vuepress.vuejs.org/>`_.
|
||||
It uses `Vue.js <https://vuejs.org/>`_ &
|
||||
`Stylus <http://stylus-lang.com/>`_ managed by
|
||||
`webpack <https://webpack.js.org/>`_
|
||||
(through `vue-cli <https://cli.vuejs.org/>`_).
|
||||
|
||||
|
||||
It uses `Vue.js <https://vuejs.org/>`_ and LessCSS managed by
|
||||
`webpack <https://webpack.js.org>`_ through `vue-cli <https://cli.vuejs.org/>`_.
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
|
@ -21,22 +18,14 @@ First install the theme:
|
|||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip install sphinx_press_theme
|
||||
$ pip install sphinx_nervproject_theme
|
||||
|
||||
|
||||
On Sphinx project's ``conf.py``: set the theme name to ``press``.
|
||||
On Sphinx project's ``conf.py``: set the theme name to ``nervproject``.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
html_theme = "press"
|
||||
html_theme = "nervproject"
|
||||
|
||||
|
||||
See details on `Sphinx theming docs <http://www.sphinx-doc.org/en/master/theming.html#using-a-theme>`_.
|
||||
|
||||
|
||||
Status
|
||||
======
|
||||
|
||||
**Press** theme is still in **BETA**.
|
||||
|
||||
Contributions are welcome.
|
||||
|
|
|
|||
|
|
@ -19,9 +19,9 @@
|
|||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'sphinx_press_theme'
|
||||
copyright = '2018, Eduardo Naufel Schettino'
|
||||
author = 'Eduardo Naufel Schettino'
|
||||
project = 'sphinx_nervproject_theme'
|
||||
copyright = '2020, kujiu'
|
||||
author = 'kujiu'
|
||||
|
||||
# The short X.Y version
|
||||
version = ''
|
||||
|
|
@ -79,7 +79,7 @@ pygments_style = None
|
|||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'press'
|
||||
html_theme = 'nervproject'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
|
|
@ -106,7 +106,7 @@ html_static_path = ['_static']
|
|||
# -- Options for HTMLHelp output ---------------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'sphinx_press_themedoc'
|
||||
htmlhelp_basename = 'sphinx_nervproject_themedoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ------------------------------------------------
|
||||
|
|
@ -133,7 +133,7 @@ latex_elements = {
|
|||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'sphinx_press_theme.tex', 'sphinx\\_press\\_theme Documentation',
|
||||
(master_doc, 'sphinx_nervproject_theme.tex', 'sphinx\\_press\\_theme Documentation',
|
||||
'Eduardo Naufel Schettino', 'manual'),
|
||||
]
|
||||
|
||||
|
|
@ -143,7 +143,7 @@ latex_documents = [
|
|||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'sphinx_press_theme', 'sphinx_press_theme Documentation',
|
||||
(master_doc, 'sphinx_nervproject_theme', 'sphinx_nervproject_theme Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
|
||||
|
|
@ -154,8 +154,8 @@ man_pages = [
|
|||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'sphinx_press_theme', 'sphinx_press_theme Documentation',
|
||||
author, 'sphinx_press_theme', 'One line description of project.',
|
||||
(master_doc, 'sphinx_nervproject_theme', 'sphinx_nervproject_theme Documentation',
|
||||
author, 'sphinx_nervproject_theme', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
Configuration
|
||||
=============
|
||||
|
||||
The Press theme webpage is composed of a fixed header, a sidebar and main content area.
|
||||
The NervProject theme webpage is composed of a fixed header, a sidebar and main content area.
|
||||
|
||||
The ``util`` folder contains Jinja2 snippets to be *included*,
|
||||
from main templates. Those can be easily replaced by theme users.
|
||||
|
|
@ -54,12 +54,51 @@ If provided, creates external links (e.g. Github) in the top right corner:
|
|||
|
||||
.. code-block:: python
|
||||
|
||||
html_theme_options = {
|
||||
"external_links": [
|
||||
("Github", "https://github.com/username/repo"),
|
||||
("Other", "https://bla.com")
|
||||
]
|
||||
}
|
||||
html_theme_options = {
|
||||
"logoalt": project,
|
||||
"social": [
|
||||
('iconset', 'icon', 'text', 'link'),
|
||||
],
|
||||
"twitter_user": "",
|
||||
"mastodon_user": "@user@instance",
|
||||
"fathom": {
|
||||
'url': 'example.org',
|
||||
'id': 'FATHOM',
|
||||
},
|
||||
'isso': {
|
||||
'prefix': '/isso',
|
||||
'url': baseurl + '/isso',
|
||||
'require_author': "true",
|
||||
'lang': 'fr',
|
||||
'reply_to_self': "true",
|
||||
'require_author': "true",
|
||||
'require_email': "false",
|
||||
'reply_notif': "true",
|
||||
'max_comments_top': 20,
|
||||
'max_comments_nested': 20,
|
||||
'reveal_on_click': 20,
|
||||
'avatar': "true",
|
||||
'vote': "false",
|
||||
'vote_levels': "",
|
||||
'feed': "true",
|
||||
},
|
||||
"license": {
|
||||
'type': 'CC',
|
||||
'subtype': 'BY-SA',
|
||||
'version': '4.0',
|
||||
'url': 'https://creativecommons.org/licenses/by-sa/4.0/legalcode'
|
||||
}
|
||||
}
|
||||
html_sidebars = {
|
||||
'**': [
|
||||
'about.html',
|
||||
'postcard.html', 'util/sidetoc.html',
|
||||
'recentposts.html', 'tagcloud.html',
|
||||
'categories.html', 'archives.html',
|
||||
'social.html',
|
||||
'util/searchbox.html',
|
||||
],
|
||||
}
|
||||
|
||||
Templates
|
||||
=========
|
||||
|
|
@ -143,3 +182,10 @@ Links for previous/next page.
|
|||
|
||||
Copyright information.
|
||||
|
||||
``ui/src/vuepress/styles/config.less``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
This file contains the four sub-themes color schemes.
|
||||
You can fork and rebuild a theme from scratch changing
|
||||
this file, or using CSS priority rules to override
|
||||
values.
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
.. sphinx_press_theme documentation master file, created by
|
||||
.. sphinx_nervproject_theme documentation master file, created by
|
||||
sphinx-quickstart on Mon Jul 30 11:44:38 2018.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
sphinx_press_theme
|
||||
==================
|
||||
sphinx_nervproject_theme
|
||||
========================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
|
@ -12,7 +12,6 @@ sphinx_press_theme
|
|||
|
||||
about
|
||||
configuration
|
||||
who
|
||||
changes
|
||||
|
||||
.. toctree::
|
||||
|
|
|
|||
|
|
@ -1,14 +0,0 @@
|
|||
Who is using **Press** Theme
|
||||
============================
|
||||
|
||||
If you this theme please add your site below:
|
||||
|
||||
|
||||
- `doit <https://pydoit.org>`_
|
||||
- `Crudcast <https://crudcast.readthedocs.io/en/latest/>`_
|
||||
- `Friendly ML Tutorial <https://aunnnn.github.io/ml-tutorial/html/index.html>`_
|
||||
- `Kube Control <https://ktl.leftxs.org/>`_
|
||||
- `Butter MAS Python API <https://bennymeg.github.io/Butter.MAS.PythonAPI/>`_
|
||||
- `trcls <https://trcls.ningyuan.io>`_
|
||||
- `bedshape <https://bedshape.ningyuan.io>`_
|
||||
- `DNA Chisel <https://edinburgh-genome-foundry.github.io/DnaChisel/>`_
|
||||
4
setup.py
4
setup.py
|
|
@ -27,7 +27,7 @@ with open("README.rst", "r") as fh:
|
|||
|
||||
setup(
|
||||
name="sphinx_nervproject_theme",
|
||||
version="1.0.2",
|
||||
version="1.0.3",
|
||||
url="https://procrastinator.nerv-project.eu/nerv-project/communication/sphinx_nervproject_theme",
|
||||
license="EUPL 1.2",
|
||||
author="Kujiu",
|
||||
|
|
@ -58,8 +58,6 @@ setup(
|
|||
entry_points={"sphinx.html_themes": ["nervproject = sphinx_nervproject_theme"]},
|
||||
install_requires=[
|
||||
"sphinx>=3.0.0",
|
||||
"reportlab",
|
||||
"ablog",
|
||||
"sphinx-fasvg"
|
||||
],
|
||||
classifiers=[
|
||||
|
|
|
|||
|
|
@ -98,10 +98,8 @@ def add_toctree_data(app, pagename, templatename, context, doctree):
|
|||
entry_docname = tree['entries'][0][1]
|
||||
toctrees = app.env.toc_dict[entry_docname]['toctrees']
|
||||
|
||||
if toctrees:
|
||||
# FIXME
|
||||
assert len(toctrees) == 1, "Press: Not supported more then one toctree on nested toctree"
|
||||
tree = toctrees[0]
|
||||
for tree in toctrees:
|
||||
pass
|
||||
|
||||
current0 = False # same page might have multiple tocs
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
{% if ablog.archive %}
|
||||
{% if ablog and ablog.archive %}
|
||||
<nav class="sidebar-links">
|
||||
<div class="sidebar-group">
|
||||
<p class="caption"><span class="caption-text"><a href="{{ pathto(ablog.archive.docname) }}">{{ gettext('Archives') }}</a></span></p>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
{% if ablog.author %}
|
||||
{% if ablog and ablog.author %}
|
||||
<p class="caption"><span class="caption-text"><a href="{{ pathto(ablog.author.path) }}">{{ gettext('Authors') }}</a></span></p>
|
||||
<ul class="current">
|
||||
{% for coll in ablog.author %}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
{% if ablog.category %}
|
||||
{% if ablog and ablog.category %}
|
||||
<nav class="sidebar-links">
|
||||
<div class="sidebar-group">
|
||||
<p class="caption"><span class="caption-text"><a href="{{ pathto(ablog.category.path) }}">{{ gettext('Categories') }}</a></span></p>
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@
|
|||
{{ collection }}
|
||||
{% endif %}
|
||||
</h1>
|
||||
{% if ablog.blog_archive_titles %}
|
||||
{% if ablog and ablog.blog_archive_titles %}
|
||||
{% for post in collection %}
|
||||
<article class="section">
|
||||
<p>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
{% if ablog.language %}
|
||||
{% if ablog and ablog.language %}
|
||||
<p class="caption"><span class="caption-text"><a href="{{ pathto(ablog.language.path) }}">{{ gettext('Languages') }}</a></span></p>
|
||||
<ul class="current">
|
||||
{% for coll in ablog.language %}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
{% if ablog.location %}
|
||||
{% if ablog and ablog.location %}
|
||||
<p class="caption"><span class="caption-text"><a href="{{ pathto(ablog.location.path) }}">{{ gettext('Locations') }}</a></span></p>
|
||||
<ul class="current">
|
||||
{% for coll in ablog.location %}
|
||||
|
|
|
|||
|
|
@ -1,36 +1,30 @@
|
|||
{%- extends "layout.html" %}
|
||||
{% set fa = ablog.fontawesome %}
|
||||
{%- block extrahead %}
|
||||
{{ super() }}
|
||||
{% if feed_path %}
|
||||
<link rel="alternate" type="application/atom+xml" href="{{ pathto(feed_path, 1) }}/atom.xml" title="{{ feed_title }}">
|
||||
{% endif %}
|
||||
{% if ablog.fontawesome_link_cdn%}
|
||||
<link href="{{ ablog.fontawesome_link_cdn }}" rel="stylesheet">
|
||||
{% elif ablog.fontawesome_css_file %}
|
||||
<link rel="stylesheet" href="{{ pathto('_static/' + ablog.fontawesome_css_file, 1) }}" type="text/css" />
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
|
||||
{% block body %}
|
||||
{{ body }}
|
||||
<div class="section">
|
||||
{% if pagename in ablog %}
|
||||
{% if ablog and pagename in ablog %}
|
||||
{% include "postnavy.html" %}
|
||||
{% include "share.html" %}
|
||||
{% else %}
|
||||
{% if theme_share_all %}
|
||||
{% if ablog and theme_share_all %}
|
||||
{% include "share.html" %}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
{% if ablog.disqus_shortname and ablog.blog_baseurl and
|
||||
{% if ablog and ablog.disqus_shortname and ablog.blog_baseurl and
|
||||
(not ablog[pagename].nocomments) and
|
||||
((pagename in ablog and (ablog[pagename].published or
|
||||
ablog.disqus_drafts)) or
|
||||
(not pagename in ablog and ablog.disqus_pages)) %}
|
||||
{% include "util/disqus.html" %}
|
||||
{% endif %}
|
||||
{% if theme_isso and
|
||||
{% if ablog and theme_isso and
|
||||
(not ablog[pagename].nocomments) and
|
||||
((pagename in ablog and (ablog[pagename].published or
|
||||
ablog.disqus_drafts)) or
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
{% if pagename in ablog %}
|
||||
{% if ablog and pagename in ablog %}
|
||||
<div class="sidebar-links">
|
||||
<div class="sidebar-group">
|
||||
{% set post = ablog[pagename] %}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
{% if ablog.tags %}
|
||||
{% if ablog and ablog.tags %}
|
||||
<nav class="sidebar-links">
|
||||
<div class="sidebar-group">
|
||||
<p class="caption"><span class="caption-text"><a href="{{ pathto(ablog.tags.path) }}">{{ gettext('Tags') }}</a></span></p>
|
||||
|
|
|
|||
Loading…
Reference in a new issue