add docs to windows manual build

Author: arch

.github/workflows/windows_build.yml

@@ -19,7 +19,7 @@ jobs:
         uses: conda-incubator/setup-miniconda@v2
         with:
           activate-environment: build
-          environment-file: environment.yaml
+          environment-file: environment_windows.yaml
           python-version: 3.9
           auto-activate-base: false
       - name: Collect Conda Info

build.bat

@@ -1,8 +1,13 @@
 @echo off
 rmdir /Q /S "build" 2>NUL
 rmdir /Q /S "dist/funscript-editor" 2>NUL
+del "dist\\funscript-editor.zip" 2>NUL
 del funscript-editor.spec 2>NUL
-pyinstaller --add-data="funscript_editor/config/*;funscript_editor/config" --add-data="assets/*;." --hidden-import "pynput.keyboard._win32" --hidden-import "pynput.mouse._win32" funscript-editor.py
+cd docs/app
+mkdocs build
+cd ../..
+pyinstaller --add-data="funscript_editor/config/*;funscript_editor/config/" --add-data="assets/*;./" --hidden-import "pynput.keyboard._win32" --hidden-import "pynput.mouse._win32" funscript-editor.py
+move "docs\\app\\site" "dist\\funscript-editor\\funscript_editor\\docs"
 copy /Y "funscript_editor\\VERSION.txt" "dist\\funscript-editor\\funscript_editor"
 powershell Compress-Archive -LiteralPath "dist/funscript-editor" -DestinationPath "dist/funscript-editor.zip"
 

docs/app/docs/user-guide/build.md

@@ -9,7 +9,7 @@ We use [pyinstaller](https://pypi.org/project/pyinstaller/) in [miniconda](https
 First download and install [miniconda](https://docs.conda.io/en/latest/miniconda.html) (If you have already [anaconda](https://www.anaconda.com/) installed on your computer you can skip this step). Then run the following commands in the project root directory:
 
 ```
-conda env create -f environment.yaml
+conda env create -f environment_windows.yaml
 conda activate build
 build.bat
 ```
@@ -23,10 +23,11 @@ Finally you can remove the build environment with `conda env remove -n build`
 ```bash
 sudo apt update
 sudo add-apt-repository ppa:savoury1/ffmpeg4
-sudo apt install git python3 python3-pip python3-sphinx python3-opencv mkdocs python3-pyqt5 ffmpeg libmpv-dev
+sudo apt install git python3 python3-pip python3-sphinx sphinx-rtd-theme-common python3-opencv mkdocs python3-pyqt5 ffmpeg libmpv-dev
 git clone https://github.com/michael-mueller-git/Python-Funscript-Editor.git
 cd Python-Funscript-Editor
 pip install -r requirements.txt
-make all
-python3 funscript-editor.py
+make docs
 ```
+
+Now you can run the code direct with `python3 funscript-editor.py` or install install a pip package with `make all`.

docs/code/generate_doc.sh

@@ -18,6 +18,10 @@ if ! command -v sphinx-apidoc ; then
     fi
 fi
 
+if [ -z "$(pip3 list | grep "sphinx-rtd-theme")" ] ; then
+    pip3 install sphinx-rtd-theme
+fi
+
 WDIR=$PWD
 
 if [ -f index.rst ]; then

environment.yaml environment_windows.yamlenvironment.yaml renamed to environment_windows.yaml

@@ -44,13 +44,23 @@ dependencies:
   - zstd=1.4.9=h19a0ad4_0
   - pip:
     - altgraph==0.17
+    - click==8.0.1
+    - colorama==0.4.4
     - coloredlogs==15.0.1
     - cycler==0.10.0
     - future==0.18.2
+    - ghp-import==2.0.1
     - humanfriendly==9.2
+    - importlib-metadata==4.6.1
+    - jinja2==3.0.1
     - kiwisolver==1.3.1
+    - markdown==3.3.4
+    - markupsafe==2.0.1
     - matplotlib==3.4.2
+    - mergedeep==1.3.4
+    - mkdocs==1.2.1
     - opencv-contrib-python==4.5.2.54
+    - packaging==21.0
     - pefile==2021.5.24
     - pyinstaller==4.3
     - pyinstaller-hooks-contrib==2021.2
@@ -60,5 +70,8 @@ dependencies:
     - python-dateutil==2.8.1
     - python-mpv==0.5.2
     - pywin32-ctypes==0.2.0
+    - pyyaml-env-tag==0.1
     - screeninfo==0.6.7
+    - watchdog==2.1.3
+    - zipp==3.5.0
 prefix: C:\Users\win10\miniconda3\envs\build

funscript_editor/definitions.py

@@ -24,6 +24,9 @@
 elif os.path.exists(os.path.join(ROOT_DIR, '..', 'usr', 'share', os.path.basename(ROOT_DIR), 'docs')):
     APP_DOCUMENTATION_DIR = os.path.join(ROOT_DIR, '..', 'usr', 'share', os.path.basename(ROOT_DIR), 'docs', 'app', 'site')
     CODE_DOCUMENTATION_DIR = os.path.join(ROOT_DIR, '..', 'usr', 'share', os.path.basename(ROOT_DIR), 'docs', 'code', '_build', 'html')
+elif os.path.exists(os.path.join(ROOT_DIR, 'docs')):
+    APP_DOCUMENTATION_DIR = os.path.join(ROOT_DIR, 'docs')
+    CODE_DOCUMENTATION_DIR = '' # code documentation not included
 else:
     APP_DOCUMENTATION_DIR = ''
     CODE_DOCUMENTATION_DIR = ''

funscript_editor/ui/funscript_editor_window.py

@@ -124,14 +124,20 @@ def __setup_ui_binding(self):
 
         helpMenu = self.ui.menubar.addMenu("Help")
         # TODO we schold use an http server to show the documentation
-        helpMenu.addAction("App Documentation", lambda : webbrowser.open(os.path.join(APP_DOCUMENTATION_DIR, 'index.html')))
-        helpMenu.addAction("Code Documentation", lambda : webbrowser.open(os.path.join(CODE_DOCUMENTATION_DIR, 'index.html')))
+        helpMenu.addAction("App Documentation", self.__open_docs)
+        # helpMenu.addAction("Code Documentation", lambda : webbrowser.open(os.path.join(CODE_DOCUMENTATION_DIR, 'index.html')))
         helpMenu.addAction(str('Version '+VERSION))
         self.ui.seekBar.sliderReleased.connect(lambda: self.video_player.seek_frame(self.ui.seekBar.value()))
 
         self.__openVideo.connect(self.__open_video)
         self.__generateFunscript.connect(self.__generate_funscript)
 
+    def __open_docs(self):
+        app_docs = os.path.join(APP_DOCUMENTATION_DIR, 'index.html')
+        self.__logger.info("Open Application Documentation: %s", app_docs)
+        browser = webbrowser.get()
+        browser.open_new(app_docs)
+
     def __setup_shortcut_bindings(self):
         QtWidgets.QShortcut('CTRL+Left', self).activated.connect(self.__seek_prev)
         QtWidgets.QShortcut('CTRL+Right', self).activated.connect(self.__seek_next)