Skip to content

Commit

Permalink
Removed CHM from doc, added to package
Browse files Browse the repository at this point in the history
  • Loading branch information
PierreRaybaut committed Aug 8, 2023
1 parent f7e6a0a commit e836d7e
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 19 deletions.
15 changes: 0 additions & 15 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,5 @@
.. automodule:: qwt

.. only:: html and not htmlhelp

.. note::

Windows users may download the :download:`CHM Manual <_downloads/PythonQwt.chm.zip>`.

After downloading this file, you may see blank pages in the documentation.
That's because Windows is blocking CHM files for security reasons.
Fixing this problem is easy:

* Right-click the CHM file, select properties, then click “Unblock”.
* Or compress the CHM file into a zip archive and decompress it in
another directory.
* Do not open the CHM file on a network drive.

Contents:

.. toctree::
Expand Down
5 changes: 2 additions & 3 deletions scripts/build_doc.bat
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,14 @@ REM (see LICENSE file for more details)
REM ======================================================
call %~dp0utils GetScriptPath SCRIPTPATH
call %FUNC% GetLibName LIBNAME
call %FUNC% GetModName MODNAME
call %FUNC% SetPythonPath
call %FUNC% UseWinPython
set PATH=C:\Program Files\7-Zip;C:\Program Files (x86)\7-Zip;C:\Program Files\HTML Help Workshop;C:\Program Files (x86)\HTML Help Workshop;%PATH%
cd %SCRIPTPATH%\..\
if exist build\doc ( rmdir /s /q build\doc )
sphinx-build -b htmlhelp doc build\doc
hhc build\doc\%LIBNAME%.hhp
copy /y build\doc\%LIBNAME%.chm doc\_downloads
7z a doc\_downloads\%LIBNAME%.chm.zip doc\_downloads\%LIBNAME%.chm
move /y doc\%LIBNAME%.chm .
copy build\doc\*.chm %MODNAME%
sphinx-build -b html doc build\doc
call %FUNC% EndOfScript
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ def get_subpackages(name):
long_description=LONG_DESCRIPTION,
packages=get_subpackages(PACKAGE_NAME),
package_data={
PACKAGE_NAME: get_package_data(PACKAGE_NAME, (".png", ".svg", ".mo"))
PACKAGE_NAME: get_package_data(PACKAGE_NAME, (".png", ".svg", ".mo", ".chm"))
},
install_requires=["NumPy>=1.5", "QtPy>=1.3"],
extras_require={
Expand Down

0 comments on commit e836d7e

Please sign in to comment.