From b6a15c8badf6e73ff3d2a24c0f7bb09f2b855025 Mon Sep 17 00:00:00 2001 From: Etzelia Date: Fri, 12 Oct 2018 14:05:02 -0500 Subject: [PATCH 1/6] Moved docs to project --- docs/.gitignore | 6 ++ docs/Makefile | 20 ++++ docs/make.bat | 42 ++++++++ docs/source/_static/favicon.png | Bin 0 -> 2851 bytes docs/source/changelog/index.rst | 10 ++ docs/source/changelog/v1.3.rst | 26 +++++ docs/source/commands.rst | 38 +++++++ docs/source/common.rst | 3 + docs/source/conf.py | 170 ++++++++++++++++++++++++++++++++ docs/source/index.rst | 16 +++ docs/source/misc.rst | 51 ++++++++++ docs/source/permissions.rst | 39 ++++++++ 12 files changed, 421 insertions(+) create mode 100644 docs/.gitignore create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/_static/favicon.png create mode 100644 docs/source/changelog/index.rst create mode 100644 docs/source/changelog/v1.3.rst create mode 100644 docs/source/commands.rst create mode 100644 docs/source/common.rst create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst create mode 100644 docs/source/misc.rst create mode 100644 docs/source/permissions.rst diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..ae6e71a --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,6 @@ +.idea/ +*.iml +target/ +dependency-reduced-pom.xml +build/ +source/.doctrees/ \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..0a64ba2 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = JavaDocs +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..5051326 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,42 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build +set SPHINXPROJ=JavaDocs + +if "%1" == "" goto help +if "%1" == "html" goto clean + +:build +%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% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:clean +%SPHINXBUILD% -M clean %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto build + +:end +popd \ No newline at end of file diff --git a/docs/source/_static/favicon.png b/docs/source/_static/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..0764cee11fb695d67fe600330c3830643ebdb3bc GIT binary patch literal 2851 zcmV+;3*7XHP)xKIsyX%I^RPpa(FTTMY1ZX))bFzu9X>Tl^z5F}R{pm}u06h4W5A&^0e*gal z@EcFu!#_Rz902z}{-K}ClzIxuw#}P2lVus_PF(r~KC!Rn3 zGiTrzAGw|H{>h8{{AX?v?W-Hx(j+}ZMmt|IA1+@8@shJCDBfzXRO&_yL~&^uc!^HX9Y=h|t7TV}4TqA+CK za}iP?rNGSRP#J_lh(M5Ktfqc)*HfQ8c;=z6-px0D_j>@yFTC(60CJXo>-~RmU`aQ% zZ&o3pK306y}Ew;~>V;_llwP0oHT48uJGua8O;-XK6Xb#kVT zQOHrOT0~xiYkMFB;W#7-Qwmj+YO8`_88}0izzHZ+O(HMB>3KA#8t8eQFbPP51R(^5 zWiVW^$;i&u=PI8P5B|;F83JTZLJIzW|8J>TM8zpW6R1=XdJ$4eLNB7!uqagWBw>n5 z6rmeoSr&1W5=K5|$-uWmA~&W`H7K=;pdiaK;xHlhW1I~iEho{lG|N3BqI9%m0OKnyBTj8TMx|C|+#3-(A-)r!R7QQif?2sz57H=M z@zpiP9S`G3pKQ*eaMC8fr;a+f&icrqJ+T)v9O4HdMovRYiT2UkcR!*@Dcm4pZnDOO zg)Z0coJFXNI7&F@*_fH4JXOai<``~_G4ckT^L?bQ;q-j$jzi?e=%$8{pj~uHB*P>HbOtW7?J`%-H_(J& zVEcq|LbvZAQ>8F+I%k%;Ts_-hle$b0DcbcCGp#C#8&j=XOq>hxUK%r#<*<*eBl8;R zf{mtY6y6+@>nlFinr9OxyS7eX8XCK|OfuChGubFH*(kGRs*VtXC{F2*J({&55@5Pj zA&3(CwnyjkWm?q&hOY6#v2*;^J^LBE0W($sqtQmUEOz@Q+S8Y5o)4)BgWCMH@LGpg z-nc|~tV=#`kfe$?FRZb9OPh_MM=5Xe*1|f)e2%?aCz+bt!eHbf+w~H0oU+=pDHlwV zG-c$52qBoLl~^0tG%6OGr|W3lvm}wvY`cbV6I#UrQ>T5b!Q0GFRoS|!fhaZTj~vRD ziD~GpY>e4C-(s;dB#cs~TNMUwh$z;%+#RCr-!c72Z{!Ixr!#VW>XjlVF0L|kd=jNl z3f6}XH(fnPqheuu5lSg6)1X?)(-}If^=)dU0wc$#KDQGq9TO#r-uQ~YqBtQ=Q`QGA zNXTiD)ZXCwowMjkqF5i;?Atz#W#*V~*Rb7yeOFDfyfNnRi3M)lGtc_KVWL_@lY(+F zPY@;Snwua|8BwALqnN!{O|!D`HbU14W1r2_brx3o+_7&foskQ`+J;S1P1!cnq-T4G zzxwz`l%`A39XJGGLc!FTZdF+B46hg_QCEnSLaFRZ6CniCtqMX24xhY)$})D(w;8wr zy^+gW-@!6-R7)mFqG(o&v};99FLoiz*n8D9osokk1X4&LRyrdV*M}4fIm*R6t%}8s zSI;rktRTqPziXDMW`#IOxoP(t#e%`hCl?9hgj(4`lY(>08%)>Bn7YP9)nebaY06d} zfHR95oVwIut#6Y7r!K7%MkyyQt|Q|ly)IR1c<1}B;=1jdC|f4S&R%AicgRw`wQY2Q2lM8E9%LS_C0-b?PPLn9jq*}2savJSg zk({nkDHZVi@Q4@1o8IjSpL_J7o6oKG|9NEl+eW^keeGTJUjG43a}T4lN7*q`BZv~# z2M+tM*~+l7kHXq9e)QG?Q_Tuz7Q1YlX;889R4kJ;%Q(H%Bdc#=SJ6hLDczBaVd#f7 z!Eb-*Utc~0T&V*9_k8{vM}F^#=eNg+x^u1DdwqQ27%Kyt56`9S-P*?XBm6L-TFm3R zF7Aa_SXvuk=o$mtqg^X9_5zl>BQCD?S#bsZvB#d`n33yqda-lJG;;6%@{=#$s%zSr zcj9V4*_MC$ftxsb>hh(hUpfD^TeeResuYa9MN>>~nXED0sPOv5RZ0beda1y!nJTNj z5kg8Xtqz!MlyLosX4PWoMNpkZcs-;hUo>>>V}JYXu}2TTwX_28;)%s~W6GZdc>LQ( zIe6mIJIfayd-CuNju+mx)E&Kg?sAu{(^pFAbhE<94Y=dltLP3~w$HZck9~H}w-G|n zAKG|JZyvMqxexs1w~yS>b-W+_w8=>Rw2jA}JPbh1${l+6tN-@?u^V1L*(jfyZC80~ zp+gWQEOv$%IStnj3F8#o59yD+(~08dZ~pM~eksHefUiIM8t)n4-TCm#&j2tpQ9b^N zzkYU)kYe{lqj+(>KPHG08dZxpRorsT{M#kV-2IO~cysrTnZ{9ouYd2y{J-lfAHN%b zKYr-;*00@p&AC7L=m+|ryzj=H0Kf8~eee0b{{rMtIv^FIfF%F`002ovPDHLkV1j3? BadQ9w literal 0 HcmV?d00001 diff --git a/docs/source/changelog/index.rst b/docs/source/changelog/index.rst new file mode 100644 index 0000000..c09b957 --- /dev/null +++ b/docs/source/changelog/index.rst @@ -0,0 +1,10 @@ +.. include:: ../common.rst + +.. _qol_changelogs: + +Changelogs +========== + +.. toctree:: + + v1.3 \ No newline at end of file diff --git a/docs/source/changelog/v1.3.rst b/docs/source/changelog/v1.3.rst new file mode 100644 index 0000000..606f7cd --- /dev/null +++ b/docs/source/changelog/v1.3.rst @@ -0,0 +1,26 @@ +.. include:: ../common.rst + +.. _qol_v1.3: + +QoL v1.3 +======== + +Additions +--------- +* `Non-spec TP Confirmation`_- Players must confirm TPs if they are not in spec. +* `Spec-Dynmap integration`_ - Going into /spec now hides a user on the dynmap, coming out of spec returns the user to their previous hidden state +* `Showing totals in /list`_ - The /list command now shows the total count of players online +* `Welcome Message`_ - Server now welcomes new players to the server +* `Hiding Audits`_ - Added permission to bypass audit for auditors of staff +* `Console Auditing`_ - Console is now audited when running auditable commands + +.. _Non-Spec TP Confirmation: https://git.etztech.xyz/Etzelia/QoL/issues/1 +.. _Spec-Dynmap integration: https://git.etztech.xyz/Etzelia/QoL/issues/2 +.. _Showing totals in /list: https://git.etztech.xyz/Etzelia/QoL/issues/3 +.. _Welcome Message: https://git.etztech.xyz/Etzelia/QoL/issues/4 +.. _Hiding Audits: https://git.etztech.xyz/Etzelia/QoL/issues/7 +.. _Console Auditing: https://git.etztech.xyz/Etzelia/QoL/issues/10 + +Bug Fixes +--------- +None \ No newline at end of file diff --git a/docs/source/commands.rst b/docs/source/commands.rst new file mode 100644 index 0000000..3d4d86b --- /dev/null +++ b/docs/source/commands.rst @@ -0,0 +1,38 @@ +.. include:: common.rst + +.. _qol_commands: + +Commands +======== + +``/qol`` - Base command (used for reloading with ``/qol reload``) + +``/colors`` - Shows a list of all Minecraft color/formatting codes. + +``/list`` - Shows a list of players online, split by (configurable) permissions. + +``/plugins`` - Shows a list of (configurable) plugins the server is using. + +``/history `` - Returns the name history of a player. |br| +Alias ``/names`` and ``/name`` + + +``/uuid `` - Returns the UUID of a player. + +``/portal`` - Returns the coordinates where the Nether portal should be placed in the world opposite the current one. + +``/worldinfo`` - Shows which players are in which world, and whether they are outside a defined "soft border". + +``/makeme `` - Sets your group via Console, regardless of other permissions. + +``/sudo `` - Executes a command as Console. + +``/shadowmute