Merge pull request #772 from Bilal2453/docs-to-dir

docs: move to new directory

Author: squeek502

.ci/check_docs.sh

@@ -2,7 +2,7 @@
 
 set -e
 
-lua docgen.lua
+lua docs/docgen.lua
 
-git diff --quiet -- docs.md
-git diff --quiet -- meta.lua
+git diff --quiet -- docs/docs.md
+git diff --quiet -- docs/meta.lua

.ci/docscov.sh

@@ -14,7 +14,7 @@ method_definitions=$(tail -n +$after_funcs src/luv.c | sed -n '/luaL_Reg/,/^\};$
 
 for fn in `echo "$func_definitions" | grep -oP "\s+ \{\"\K([^\"]+)(?=\",)"`; do
 	# count instances of '### `uv.fn_name' in the docs
-	count=$(grep -oPc "^#+\s+\`uv\.$fn\b" docs.md)
+	count=$(grep -oPc "^#+\s+\`uv\.$fn\b" docs/docs.md)
 
 	if [ $count -eq 0 ] ; then
 		echo $fn
@@ -24,7 +24,7 @@ done
 
 for fn in `echo "$method_definitions" | grep -oP "\s+ \{\"\K([^\"]+)(?=\",)"`; do
 	# count instances of '> method form something:fn_name' in the docs
-	count=$(grep -oPc "^> method form [^:]+:$fn\b" docs.md)
+	count=$(grep -oPc "^> method form [^:]+:$fn\b" docs/docs.md)
 
 	if [ $count -eq 0 ] ; then
 		echo "$fn (method form)"

.ci/make_rockspec.sh

@@ -19,7 +19,7 @@ sed -e "${script}" -i rockspecs/luv-${version}.rockspec
 # .tar.gz
 rm -rf luv-${version}
 mkdir -p luv-${version}/deps
-cp -r src cmake CMakeLists.txt LICENSE.txt README.md docs.md libluv.pc.in luv-${version}/
+cp -r src cmake CMakeLists.txt LICENSE.txt README.md docs/docs.md libluv.pc.in luv-${version}/
 cp -r deps/libuv deps/lua-compat-5.3 deps/*.cmake deps/lua_one.c luv-${version}/deps/
 COPYFILE_DISABLE=true tar -czvf luv-${version}.tar.gz luv-${version}
 rm -rf luv-${version}

.gitattributes

@@ -1,3 +1,3 @@
-docs.md linguist-documentation
-docs.md linguist-generated
-meta.lua linguist-generated
+docs/docs.md linguist-documentation
+docs/docs.md linguist-generated
+docs/meta.lua linguist-generated

README.md

@@ -15,7 +15,7 @@ This library makes libuv available to lua scripts.  It was made for the [luvit](
 
 The library can be used by multiple threads at once.  Each thread is assumed to load the library from a different `lua_State`.  Luv will create a unique `uv_loop_t` for each state.  You can't share uv handles between states/loops.
 
-- [Luv docs](docs.md)
+- [Luv docs](docs/docs.md)
 - [Libuv docs](http://docs.libuv.org/)
 
 ```lua

docgen.lua docs/docgen.luadocgen.lua renamed to docs/docgen.lua

@@ -2,7 +2,7 @@
 --- the luv project. It processes documentation sections from docs.lua,
 --- and writes the output to markdown (docs.md) and Lua files (meta.lua).
 
-local docs = require('docs')
+local docs = dofile('docs/docs.lua')
 local doctop = docs[1]
 local types = docs[2]
 
@@ -863,10 +863,10 @@ local function main()
   -- Generate types for large inline types
   gen_types_for_doc(doctop)
 
-  local outdoc = assert(io.open('docs.md', 'w'))
+  local outdoc = assert(io.open('docs/docs.md', 'w'))
   Doc.write(outdoc, doctop)
 
-  local outmeta = assert(io.open('meta.lua', 'w'))
+  local outmeta = assert(io.open('docs/meta.lua', 'w'))
   Meta.write(outmeta, doctop)
 end