Sphinx docs (#1384)

* included changes from @nmat from separate repo into mrng

* added sphinx-doc build dir

* fixed error on non-appveyor builds

* removed unneccesary variable

* added post-build script for sphinx documenatation

* retired "move_help_files" post build script

* added sphinx-documentation files to project

* display spinx docs

* changed theme to read the docs

* fixed typo

* restructured sphinx dir

* added documentation forr keyboard shortcuts and command line switches

* more hierarchy fixes

* added known issues

* added images for sphinx docs to project

* added quick connect documentation

* added port scan documentation

* added screenshot manager documentation

* added notifications documentation

* added import/export documentation

* added ssh file transfer documentation

* added connection config documentation

* added options documentation

* added menus documentation

* converted remaining help files and tidied up resources

* fixed formatting error

* modified sphinx script to automatically grab assembly details from assembly file

* modified copyright string for automated sphinx builds

* splitted toctree

* added RTD configuration file

* added RTD badge

* use default values if assembly file cannot be found

* removed colons from headings

* Minor fixes

* Remove source link so its not confusing for users

* Fix minor spelling

* Add editorconfig for rst files

* added external tools cheat sheet

* extended known issues segment

* added contact information

* Fix list item in document:

* Under "Opening and Closing Connections"

* added infor on how to migrate from pre-NG versions

* fixed list not being rendered properly

* removed markup guide from help to move it to the github wiki

* added missing information from github wiki

* removed contributing document from repository itself to move it to the wiki

* fixed formatting error

* Add more information for import/export

* minor wording fixes

* moved troubleshooting and known issues to its own support section

* moved "folders and inheritance" under "application handling"

* Minor formatting fixes

* Formatting fixes

* Updated docs for ssh file transfer:

* Added screenshot

* Updated documentation a little

* added FAQ

* revised external tools

* fixed sphinx build errors

* changed heading format

* do not output images for sphinx docs to build dir

* removed issue/pr templates

* updated appveyer configuration

* added missing variables

* added python to path

* output PATH for debugging

* sphinx build tests

* Minor cleanup

* added sql script changes into sphinx docs

* removed unused appveyor.xml
This commit is contained in:
Faryan Rezagholi
2019-04-30 21:42:32 +02:00
committed by GitHub
parent b051e8cc46
commit 4e118493d2
141 changed files with 2963 additions and 2946 deletions

View File

@@ -12,8 +12,6 @@ Write-Output "===== Beginning $($PSCmdlet.MyInvocation.MyCommand) ====="
Write-Output "Copying TILES folder to output"
$sourceFiles = [io.path]::combine($SolutionDir , 'mRemoteV1\Resources\Tiles' )
$DestinationDir = $TargetDir
robocopy $sourceFiles $DestinationDir *.*
robocopy $sourceFiles $TargetDir *.*
Write-Output ""

View File

@@ -42,7 +42,7 @@ Format-Table -AutoSize -Wrap -InputObject @{
& "$PSScriptRoot\copy_puttyng.ps1" -SolutionDir $SolutionDir -TargetDir $TargetDir
& "$PSScriptRoot\copy_themes.ps1" -SolutionDir $SolutionDir -TargetDir $TargetDir
& "$PSScriptRoot\copy_tiles.ps1" -SolutionDir $SolutionDir -TargetDir $TargetDir
& "$PSScriptRoot\move_help_files.ps1" -TargetDir $TargetDir
& "$PSScriptRoot\sphinx_docs.ps1" -SolutionDir $SolutionDir -TargetDir $TargetDir
& "$PSScriptRoot\set_LargeAddressAware.ps1" -TargetDir $TargetDir -TargetFileName $TargetFileName
& "$PSScriptRoot\verify_LargeAddressAware.ps1" -TargetDir $TargetDir -TargetFileName $TargetFileName
& "$PSScriptRoot\tidy_files_for_release.ps1" -TargetDir $TargetDir -ConfigurationName $ConfigurationName

View File

@@ -1,23 +1,23 @@
param (
[string]
param (
[string]
[Parameter(Mandatory=$true)]
$SolutionDir,
[string]
[Parameter(Mandatory=$true)]
$TargetDir
)
Write-Output "===== Beginning $($PSCmdlet.MyInvocation.MyCommand) ====="
Write-Output "Building HTML-Documentation with Sphinx"
$path_HelpFilesDir = Join-Path -Path $TargetDir -ChildPath "Help"
Write-Output "Moving Help files to correct directory"
$path_SphinxSourceDir = Join-Path -Path $SolutionDir -ChildPath "mremoteV1\Documentation"
# Remove stale Help files, if they exist
if (Test-Path -Path $path_HelpFilesDir) {
Remove-Item -Path $path_HelpFilesDir -Recurse -Force
}
# Move Help files
Move-Item -Path (Join-Path -Path $TargetDir -ChildPath "Resources\Help") -Destination $path_HelpFilesDir -Force
Start-Sleep -Seconds 2
Remove-Item -Path (Join-Path -Path $TargetDir -ChildPath "Resources") -Recurse -Force
sphinx-build $path_SphinxSourceDir $path_HelpFilesDir
Write-Output ""

View File

@@ -13,7 +13,12 @@ Write-Output "===== Beginning $($PSCmdlet.MyInvocation.MyCommand) ====="
# Remove unnecessary files from Release versions
if ($ConfigurationName -match "Release") {
Write-Output "Removing unnecessary files from Release versions"
Remove-Item -Path (Join-Path -Path $TargetDir -ChildPath "app.publish") -Recurse -Force
$test = Join-Path -Path $TargetDir -ChildPath "app.publish"
if (Test-Path $test -PathType Container) {
Remove-Item -Path (Join-Path -Path $TargetDir -ChildPath "app.publish") -Recurse -Force
}
$filesToDelete = Get-ChildItem -Path $TargetDir -Recurse -Include @(
"*.publish",
"*.xml",