Verified Commit da18a5e0 authored by SIMONIN Matthieu's avatar SIMONIN Matthieu
Browse files

Some refacto before publishing

- add doc
- rename python module -> distem
parent 6dbaf5c9
# Byte-compiled / optimized / DLL files
# C extensions
# Distribution / packaging
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
# Installer logs
# Unit test / coverage reports
# Translations
# Django stuff:
# Flask stuff:
# Scrapy stuff:
# Sphinx documentation
# PyBuilder
# Jupyter Notebook
# IPython
# pyenv
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
# celery beat schedule file
# SageMath parsed files
# Environments
# Spyder project settings
# Rope project settings
# mkdocs documentation
# mypy
# Pyre type checker
......@@ -477,10 +477,10 @@ class Distem():
vnodename(str) The name of the virtual node
val(Float) The frequency defined as a value in MHz or as a ratio (percentage of the physical core frequency).
unit(str) Tell if val is a frequency or a ratio (allowed values are mhz and ration)
corenb(Integer) The number of cores to allocate (need to have enough free ones on the physical node)
vnodename(str): The name of the virtual node
val(Float): The frequency defined as a value in MHz or as a ratio (percentage of the physical core frequency).
unit(str): Tell if val is a frequency or a ratio (allowed values are mhz and ration)
corenb(Integer): The number of cores to allocate (need to have enough free ones on the physical node)
{Dictionnary} The virtual CPU description (see {file:files/ Resource Description - VCPU})
# Minimal makefile for Sphinx documentation
# You can set these variables from the command line.
SPHINXBUILD = python -msphinx
SPHINXPROJ = enoslib
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
\ No newline at end of file
# -*- coding: utf-8 -*-
# python-distem documentation build configuration file, created by
# sphinx-quickstart on Thu Sep 21 21:45:39 2017.
# This file is execfile()d with the current directory set to its
# containing dir.
# Note that not all possible configuration values are present in this
# autogenerated file.
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
import os
import sphinx_rtd_theme
import sys
sys.path.insert(0, os.path.abspath('..'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
#extensions = []
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'python-distem'
copyright = u'2019, Romain Olivo, Matthieu Simonin'
author = u'Romain Olivo, Matthieu Simonin'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
# The short X.Y version.
import pkg_resources
version = pkg_resources.require("distem")[0].version
# The full version, including alpha/beta/rc tags.
release = version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#html_theme = 'alabaster'
html_theme = "sphinx_rtd_theme"
# 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
# documentation.
# html_theme_options = {}
# 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,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
# This is required for the alabaster theme
# refs:
html_sidebars = {
'**': [
'relations.html', # needs 'show_related': True theme option to display
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'pythondistemdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
# Latex figure (float) alignment
# 'figure_align': 'htbp',
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'python-distem.tex', u'python-distam Documentation',
u'python-distem, Matthieu Simonin', 'manual'),
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'python-distem', u'python-distem Documentation',
[author], 1)
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'python-distem', u'python-distem Documentation',
author, 'python-distem', 'One line description of project.',
# Document also the __init__
autoclass_content = "both"
.. enoslib documentation master file, created by
sphinx-quickstart on Thu Sep 21 21:45:39 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
API documentation
.. automodule:: distem
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=python -msphinx
set BUILDDIR=_build
set SPHINXPROJ=enoslib
if "%1" == "" goto help
if errorlevel 9009 (
echo.The Sphinx module was not found. Make sure you have Sphinx installed,
echo.then set the SPHINXBUILD environment variable to point to the full
echo.path of the 'sphinx-build' executable. Alternatively you may add the
echo.Sphinx directory to PATH.
echo.If you don't have Sphinx installed, grab it from
exit /b 1
goto end
# tox -epy27
skipsdist = True
envlist = pep8
whitelist_externals = make
deps = -r{toxinidir}/test-requirements.txt
extras = chameleon
commands =
py.test --junit-xml=./utest.xml --cov-report=xml --cov-report=term-missing --cov={toxinidir}/enoslib {toxinidir}/enoslib/tests/unit
usedevelop = True
changedir = enoslib/
commands = flake8
distribute = false
changedir = docs/
commands =
/bin/rm -rf ../_build
make clean
make html
# Calling `flake8` will read this file to find configuration
# information.
# F821 : F821 undefined name 'basestring' (python3)
ignore = E121,E122,E123,E124,E125,E127,E128,E129,E131,E241,H405,F821, W503, W292
show-source = true
exclude = venv,.git,.tox,dist,*egg,ansible,tests
max-complexity = 12
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment