coriolis/documentation/pelicanconf.py

146 lines
4.3 KiB
Python
Raw Normal View History

#!/usr/bin/env python
# -*- coding: utf-8 -*- #
from __future__ import unicode_literals
import os
import os.path
import socket
pelicanDir = os.path.abspath( os.getcwd() )
hostname = socket.gethostname()
if pelicanDir.endswith('coriolis/documentation'):
pluginsDir = '/dsk/l1/pelican/pelican-plugins'
outputDir = 'output/'
siteUrl = ''
elif hostname.startswith('lepka'):
pluginsDir = '/dsk/l1/pelican/pelican-plugins'
outputDir = '/dsk/l1/httpd/coriolis'
siteUrl = 'http://localhost/coriolis'
else:
pluginsDir = '/data/git/pelican-plugins'
outputDir = 'output/'
siteUrl = ''
PLUGIN_PATHS = [ pluginsDir ]
PLUGINS = [ 'bootstrap-rst' ]
STATIC_PATHS = [ 'pages/users-guide'
, 'pages/python-tutorial'
Migration towards Python3, first stage: still based on C-Macros. * New: Python/C++ API level: * Write a new C++/template wrapper to get rid of boost::python * The int & long Python type are now merged. So a C/C++ level, it became "PyLong_X" (remove "PyInt_X") and at Python code level, it became "int" (remove "long"). * Change: VLSISAPD finally defunct. * Configuration is now integrated as a Hurricane component, makes use of the new C++/template wrapper. * vlsisapd is now defunct. Keep it in the source for now as some remaining non essential code may have to be ported in the future. * Note: Python code (copy of the migration howto): * New print function syntax print(). * Changed "dict.has_key(k)" for "k" in dict. * Changed "except Exception, e" for "except Exception as e". * The division "/" is now the floating point division, even if both operand are integers. So 3/2 now gives 1.5 and no longer 1. The integer division is now "//" : 1 = 3//2. So have to carefully review the code to update. Most of the time we want to use "//". We must never change to float for long that, in fact, represents DbU (exposed as Python int type). * execfile() must be replaced by exec(open("file").read()). * iter().__next__() becomes iter(x).__next__(). * __getslice__() has been removed, integrated to __getitem__(). * The formating used for str(type(o)) has changed, so In Stratus, have to update them ("<class 'MyClass'>" instead of "MyClass"). * the "types" module no longer supply values for default types like str (types.StringType) or list (types.StringType). Must use "isinstance()" where they were occuring. * Remove the 'L' to indicate "long integer" (like "12L"), now all Python integer are long. * Change in bootstrap: * Ported Coriolis builder (ccb) to Python3. * Ported Coriolis socInstaller.py to Python3. * Note: In PyQt4+Python3, QVariant no longer exists. Use None or directly convert using the python syntax: bool(x), int(x), ... By default, it is a string (str). * Note: PyQt4 bindings & Python3 under SL7. * In order to compile user's must upgrade to my own rebuild of PyQt 4 & 5 bindings 4.19.21-1.el7.soc. * Bug: In cumulus/plugins.block.htree.HTree.splitNet(), set the root buffer of the H-Tree to the original signal (mainly: top clock). Strangely, it was only done when working in full chip mode.
2021-09-19 12:41:24 -05:00
, 'pages/python-cpp-new'
, 'pages/python-cpp'
, 'pages/stratus'
, 'pages/check-toolkit'
, 'pages/design-flow'
, 'pages/rds'
#, 'scripts'
, 'images'
, 'pdfs'
]
AUTHOR = u'Jean-Paul Chaput'
SITENAME = u'Coriolis VLSI CAD Tools [offline]'
SITEURL = siteUrl
THEME = './themes/nest-coriolis'
#THEME = 'nest'
#THEME = 'dev-random'
#THEME = 'brutalist'
DELETE_OUTPUT_DIRECTORY = True
ARTICLE_EXCLUDES = [ ]
PATH = 'content'
PAGE_PATHS = [ 'pages' ]
TIMEZONE = 'Europe/Paris'
DEFAULT_LANG = u'en'
# Feed generation is usually not desired when developing
FEED_ALL_ATOM = None
CATEGORY_FEED_ATOM = None
TRANSLATION_FEED_ATOM = None
AUTHOR_FEED_ATOM = None
AUTHOR_FEED_RSS = None
DISPLAY_PAGES_ON_MENU = True
# Blogroll
#SOCIAL = (('Pelican' , 'http://getpelican.com/' ),
# ('Python.org', 'http://python.org/' ),
# ('Jinja2' , 'http://jinja.pocoo.org/'),)
SOCIAL = None
# Social widget
LINKS = (('Alliance/Coriolis' , 'https://coriolis.lip6.fr/'),
('CIAN Team Website' , 'https://www-soc.lip6.fr/' ),
('Free Silicon Foundation', 'https://f-si.org' ),)
DEFAULT_PAGINATION = 10
IGNORE_FILES = [ 'UsersGuide.rst' # For User's Guide.
, 'definitions.rst'
, 'Abstract.rst'
, 'DesignFlow.rst'
, 'HTML_defs.rst'
, 'Pelican_defs.rst'
, 'Installation.rst'
, 'LicenseCredits.rst'
, 'Releases.rst'
, 'ScriptsPlugins.rst'
, 'ViewerTools.rst'
, 'QuickStart.rst' # For Design Flow.
Migration towards Python3, first stage: still based on C-Macros. * New: Python/C++ API level: * Write a new C++/template wrapper to get rid of boost::python * The int & long Python type are now merged. So a C/C++ level, it became "PyLong_X" (remove "PyInt_X") and at Python code level, it became "int" (remove "long"). * Change: VLSISAPD finally defunct. * Configuration is now integrated as a Hurricane component, makes use of the new C++/template wrapper. * vlsisapd is now defunct. Keep it in the source for now as some remaining non essential code may have to be ported in the future. * Note: Python code (copy of the migration howto): * New print function syntax print(). * Changed "dict.has_key(k)" for "k" in dict. * Changed "except Exception, e" for "except Exception as e". * The division "/" is now the floating point division, even if both operand are integers. So 3/2 now gives 1.5 and no longer 1. The integer division is now "//" : 1 = 3//2. So have to carefully review the code to update. Most of the time we want to use "//". We must never change to float for long that, in fact, represents DbU (exposed as Python int type). * execfile() must be replaced by exec(open("file").read()). * iter().__next__() becomes iter(x).__next__(). * __getslice__() has been removed, integrated to __getitem__(). * The formating used for str(type(o)) has changed, so In Stratus, have to update them ("<class 'MyClass'>" instead of "MyClass"). * the "types" module no longer supply values for default types like str (types.StringType) or list (types.StringType). Must use "isinstance()" where they were occuring. * Remove the 'L' to indicate "long integer" (like "12L"), now all Python integer are long. * Change in bootstrap: * Ported Coriolis builder (ccb) to Python3. * Ported Coriolis socInstaller.py to Python3. * Note: In PyQt4+Python3, QVariant no longer exists. Use None or directly convert using the python syntax: bool(x), int(x), ... By default, it is a string (str). * Note: PyQt4 bindings & Python3 under SL7. * In order to compile user's must upgrade to my own rebuild of PyQt 4 & 5 bindings 4.19.21-1.el7.soc. * Bug: In cumulus/plugins.block.htree.HTree.splitNet(), set the root buffer of the H-Tree to the original signal (mainly: top clock). Strangely, it was only done when working in full chip mode.
2021-09-19 12:41:24 -05:00
, 'PythonTutorial.rst' # For Python Tutorial & New.
, 'Introduction.rst'
Migration towards Python3, first stage: still based on C-Macros. * New: Python/C++ API level: * Write a new C++/template wrapper to get rid of boost::python * The int & long Python type are now merged. So a C/C++ level, it became "PyLong_X" (remove "PyInt_X") and at Python code level, it became "int" (remove "long"). * Change: VLSISAPD finally defunct. * Configuration is now integrated as a Hurricane component, makes use of the new C++/template wrapper. * vlsisapd is now defunct. Keep it in the source for now as some remaining non essential code may have to be ported in the future. * Note: Python code (copy of the migration howto): * New print function syntax print(). * Changed "dict.has_key(k)" for "k" in dict. * Changed "except Exception, e" for "except Exception as e". * The division "/" is now the floating point division, even if both operand are integers. So 3/2 now gives 1.5 and no longer 1. The integer division is now "//" : 1 = 3//2. So have to carefully review the code to update. Most of the time we want to use "//". We must never change to float for long that, in fact, represents DbU (exposed as Python int type). * execfile() must be replaced by exec(open("file").read()). * iter().__next__() becomes iter(x).__next__(). * __getslice__() has been removed, integrated to __getitem__(). * The formating used for str(type(o)) has changed, so In Stratus, have to update them ("<class 'MyClass'>" instead of "MyClass"). * the "types" module no longer supply values for default types like str (types.StringType) or list (types.StringType). Must use "isinstance()" where they were occuring. * Remove the 'L' to indicate "long integer" (like "12L"), now all Python integer are long. * Change in bootstrap: * Ported Coriolis builder (ccb) to Python3. * Ported Coriolis socInstaller.py to Python3. * Note: In PyQt4+Python3, QVariant no longer exists. Use None or directly convert using the python syntax: bool(x), int(x), ... By default, it is a string (str). * Note: PyQt4 bindings & Python3 under SL7. * In order to compile user's must upgrade to my own rebuild of PyQt 4 & 5 bindings 4.19.21-1.el7.soc. * Bug: In cumulus/plugins.block.htree.HTree.splitNet(), set the root buffer of the H-Tree to the original signal (mainly: top clock). Strangely, it was only done when working in full chip mode.
2021-09-19 12:41:24 -05:00
, 'Implementation.rst'
, 'Environment.rst'
, 'CellNetComponent.rst'
, 'Collections.rst'
, 'CgtScript.rst'
, 'Netlist.rst'
, 'RealDesigns.rst'
, 'ToolEngines.rst'
, 'AdvancedTopics.rst'
, 'AdvancedTopics.rst'
, 'pdfHeader.rst'
, 'PythonCpp.rst' # For Python/C++ Tutorial
, 'Introduction.rst'
, 'Configuration.rst'
, 'DBoStandalone.rst'
, 'DBoHierarchy.rst'
, 'NonDBo.rst'
, 'DbU.rst'
, 'Name.rst'
, 'Stratus.rst' # For Stratus.
, 'Developper.rst'
, 'DpGen.rst'
, 'Language.rst'
, 'Patterns.rst'
, 'CheckToolkit.rst' # Alliance Check Toolkit.
, 'README.rst'
, 'RDS.rst' # For RDS.
, 'RDSpage.rst'
, 'Installation.rst' # For Alliance.
]
# Uncomment following line if you want document-relative URLs when developing
RELATIVE_URLS = True
NEST_INDEX_HEADER_TITLE = u'Alliance/Coriolis VLSI CAD Tools'
NEST_HEADER_LOGO = '/images/common/Coriolis-logo-white-4-small.png'
NEST_HEADER_IMAGES = 'common/layout-motif-faded-4.png'
NEST_LINKS_COLUMN_TITLE = u'Links'
NEST_SOCIAL_COLUMN_TITLE = u'Social'
NEST_SITEMAP_COLUMN_TITLE = u'Social'
NEST_COPYRIGHT = u'Copyright © 2020-2020 Sorbonne Universite'
MENUITEMS = [ ('Git' , '/pages/gitlab.html' )
, ('Documentation', '/pages/documentation.html' ) ]