From edd75703e2e51eab8ccf611a01486eb26e6929e9 Mon Sep 17 00:00:00 2001 From: Aaron Axvig Date: Sat, 28 Mar 2020 18:32:53 -0400 Subject: [PATCH 1/2] Improved steps for building docs on Windows --- README.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.rst b/README.rst index ace8ebdd..d7b75876 100644 --- a/README.rst +++ b/README.rst @@ -66,6 +66,8 @@ The above will write the rendered version of the specification to Windows users ~~~~~~~~~~~~~ +The ``source`` program does not exist on Windows, so instead run one of the +``activate`` files in ``.\env\Scripts\`` to activate the virtual environment. If you're on Windows Vista or higher, be sure that the "Symbolic Links" option was selected when installing Git prior to cloning this repository. If @@ -81,6 +83,24 @@ cloned matrix-doc directory and run the following:: This will delete the file and replace it with a symlink. Git should not detect this as a change, and you should be able to go back to building the project. +Powershell doesn't have ``mklink`` so use cmd. Or, here is the full set of +steps for Powershell: + +.. code-block:: powershell + + virtualenv -p python3 env + .\env\Scripts\pip.exe install -r .\scripts\requirements.txt + + .\env\Scripts\activate.ps1 # Adds a global function 'deactivate' for leaving the env when you are done. + .\Scripts\gendoc.py + + # If you get errors: + cd api\client-server\definitions + del event-schemas + New-Item -ItemType SymbolicLink -Name event-schemas -Value "..\..\..\event-schemas" + cd ..\..\..\ + .\scripts\gendoc.py + Generating the OpenAPI (Swagger) specs -------------------------------------- From 2f5d8a4a271982a786ded1b2dc23a02e35c95583 Mon Sep 17 00:00:00 2001 From: aaronaxvig Date: Mon, 30 Mar 2020 14:32:45 -0400 Subject: [PATCH 2/2] Removed PowerShell stuff Clarified to use Command Prompt as recommended is pull request #2479, removed all PowerShell stuff. --- README.rst | 20 +------------------- 1 file changed, 1 insertion(+), 19 deletions(-) diff --git a/README.rst b/README.rst index d7b75876..01ea8e72 100644 --- a/README.rst +++ b/README.rst @@ -73,7 +73,7 @@ If you're on Windows Vista or higher, be sure that the "Symbolic Links" option was selected when installing Git prior to cloning this repository. If you're still seeing errors about files not being found it is likely because the symlink at ``api/client-server/definitions/event-schemas`` looks like a -file. To correct the problem, open an Administrative/Elevated shell in your +file. To correct the problem, open an Administrative/Elevated Command Prompt in your cloned matrix-doc directory and run the following:: cd api\client-server\definitions @@ -83,24 +83,6 @@ cloned matrix-doc directory and run the following:: This will delete the file and replace it with a symlink. Git should not detect this as a change, and you should be able to go back to building the project. -Powershell doesn't have ``mklink`` so use cmd. Or, here is the full set of -steps for Powershell: - -.. code-block:: powershell - - virtualenv -p python3 env - .\env\Scripts\pip.exe install -r .\scripts\requirements.txt - - .\env\Scripts\activate.ps1 # Adds a global function 'deactivate' for leaving the env when you are done. - .\Scripts\gendoc.py - - # If you get errors: - cd api\client-server\definitions - del event-schemas - New-Item -ItemType SymbolicLink -Name event-schemas -Value "..\..\..\event-schemas" - cd ..\..\..\ - .\scripts\gendoc.py - Generating the OpenAPI (Swagger) specs --------------------------------------