-
Notifications
You must be signed in to change notification settings - Fork 81
Items created/updated to correct tech writer's build #220
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,3 +4,6 @@ _build | |
| *.sav | ||
| *.log | ||
| *.warnings | ||
| .tox | ||
| .tox | ||
| MANIFEST | ||
| 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 |
| 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 | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 Cc: @mmaka1 , @xiulipan, @lgirdwood .
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @deb-intel , @intelkevinputnam you forgot to update the documentation:
( A more general discussion about versioning happened in #198, thanks again @intelkevinputnam ) |
||
| sphinx_rtd_theme | ||
| sphinxcontrib-plantuml | ||
| 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/', | ||
deb-intel marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ) | ||
| 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} | ||
|
|
Uh oh!
There was an error while loading. Please reload this page.