Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@ _build
*.sav
*.log
*.warnings
.tox
.tox
MANIFEST
36 changes: 36 additions & 0 deletions make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build
set DOC_TAG=development

if "%1" == "" goto help

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% -t %DOC_TAG%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

:end
popd
6 changes: 3 additions & 3 deletions scripts/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
breathe>=4.9.1
sphinx>=1.7.5
docutils>=0.14
breathe==4.14.1
sphinx==2.4.4
docutils==0.16
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These seem to be "bleeding edge" versions. Except for PR #225 I could build everything just fine with my stock sphinx 2.1.2

Versions aside, @deb-intel can we please revert to >= to force fewer users to have one virtualenv per sphinx project?

Cc: @mmaka1 , @xiulipan, @lgirdwood .

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@deb-intel , @intelkevinputnam you forgot to update the documentation:
https://thesofproject.github.io/latest/contribute/process/docbuild.html#install-documentation-tools

Our documentation processing has been tested to run with:

Python 3.6.3
Doxygen version 1.8.13
Sphinx version 1.7.5
Breathe version 4.9.1
docutils version 0.14
sphinx_rtd_theme version 0.4.0

( A more general discussion about versioning happened in #198, thanks again @intelkevinputnam )

sphinx_rtd_theme
sphinxcontrib-plantuml
11 changes: 11 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/usr/bin/env python

from distutils.core import setup

setup(name='Sphinx GUI Utility',
version='0.1',
description='Build Sphinx docs from a GUI',
author='Kevin Putnam',
author_email='kevin.putnam@intel.com',
url='https://gitlab.devtools.intel.com/kputnam/doc-gui/',
)
13 changes: 13 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[tox]
envlist = py3-{mylinux,mywindows}

[testenv]
platform = mylinux: linux
mywindows: win32
whitelist_externals = make.bat
/usr/bin/make
deps = -rscripts\requirements.txt
commands =
mylinux: make {posargs}
mywindows: make.bat {posargs}