Skip to content

Commit 7237c18

Browse files
MauricioFauthMauricioFauth
authored
Merge pull request #18836 from MauricioFauth/docs-dir
Move doc directory to docs
2 parents 9900c5d + 1f443ca commit 7237c18

55 files changed

Lines changed: 26 additions & 26 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/other-tools.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
run: pip install 'Sphinx'
2828

2929
- name: Build the documentation
30-
run: make -C doc html SPHINXOPTS='-n -W -a'
30+
run: make -C docs html SPHINXOPTS='-n -W -a'
3131

3232
build-release:
3333
runs-on: ubuntu-latest

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ web.config
3636
*~
3737
# API documentation
3838
/apidoc/
39-
/doc/linkcheck/
39+
/docs/linkcheck/
4040
# Demo server
4141
revision-info.php
4242
# PHP_CodeSniffer

‎README‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Summary
1212

1313
phpMyAdmin is intended to handle the administration of MySQL over the web.
1414
For a summary of features, list of requirements, and installation instructions,
15-
please see the documentation in the ./doc/ folder or at https://docs.phpmyadmin.net/
15+
please see the documentation in the ./docs/ folder or at https://docs.phpmyadmin.net/
1616

1717
Copyright
1818
---------
@@ -22,7 +22,7 @@ Copyright © 1998 onwards -- the phpMyAdmin team
2222
Certain libraries are copyrighted by their respective authors;
2323
see the full copyright list for details.
2424

25-
For full copyright information, please see ./doc/copyright.rst
25+
For full copyright information, please see ./docs/copyright.rst
2626

2727
License
2828
-------

‎README.rst‎

Lines changed: 1 addition & 1 deletion

‎bin/internal/check-release-excludes.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ validateExtension() {
3636
extension="${filename##*.}"
3737

3838
case $pathWithoutFirst in
39-
doc/*)
39+
docs/*)
4040
if [ "${extension}" != "png" ] && [ "${extension}" != "txt" ] &&
4141
[ "${extension}" != "html" ] && [ "${extension}" != "js" ] &&
4242
[ "${extension}" != "css" ] && [ "${extension}" != "gif" ]; then

‎bin/internal/create-release.sh‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ Please ensure you have incremented rc count or version in the repository :
381381
- run ./bin/console set-version $version
382382
- in $VERSION_FILE Version class:
383383
- check that VERSION, MAJOR, MINOR and PATCH are correct.
384-
- in doc/conf.py the line
384+
- in docs/conf.py the line
385385
" version = '$version' "
386386
- in README the "Version" line
387387
- in package.json the line
@@ -437,8 +437,8 @@ if [ $do_ci -eq 0 ] && [ -$do_daily -eq 0 ] ; then
437437
echo "There seems to be wrong version in $VERSION_FILE!"
438438
exit 2
439439
fi
440-
if ! grep -q "version = '$version'" doc/conf.py ; then
441-
echo "There seems to be wrong version in doc/conf.py"
440+
if ! grep -q "version = '$version'" docs/conf.py ; then
441+
echo "There seems to be wrong version in docs/conf.py"
442442
exit 2
443443
fi
444444
if ! grep -q "Version $version\$" README ; then
@@ -461,8 +461,8 @@ fi
461461
# Building documentation
462462
echo "* Running sphinx-build (version: $(sphinx-build --version))"
463463
echo "* Generating documentation"
464-
LC_ALL=C make -C doc html
465-
find doc -name '*.pyc' -print0 | xargs -0 -r rm -f
464+
LC_ALL=C make -C docs html
465+
find docs -name '*.pyc' -print0 | xargs -0 -r rm -f
466466

467467
# Check for gettext support
468468
if [ -d resources/po ] ; then
@@ -614,11 +614,11 @@ for kit in $KITS ; do
614614
# Gettext po files (if they were not removed by ./bin/internal/lang-cleanup.sh)
615615
rm -rf resources/po
616616
# Documentation source code
617-
mv doc/html htmldoc
618-
rm -r doc
619-
mkdir doc
620-
mv htmldoc doc/html
621-
rm doc/html/.buildinfo doc/html/objects.inv
617+
mv docs/html htmldoc
618+
rm -r docs
619+
mkdir docs
620+
mv htmldoc docs/html
621+
rm docs/html/.buildinfo docs/html/objects.inv
622622
rm -r node_modules
623623
# Remove bin files for non source version
624624
# https://github.com/phpmyadmin/phpmyadmin/issues/16033
@@ -755,7 +755,7 @@ Todo now:
755755
" Version 2.7.1-dev "
756756
- in package.json the line
757757
" "version": " 2.7.1-dev", "
758-
- in doc/conf.py (if it exists) the line
758+
- in docs/conf.py (if it exists) the line
759759
" version = '2.7.1-dev' "
760760
761761
8. on https://github.com/phpmyadmin/phpmyadmin/milestones close the milestone corresponding to the released version (if this is a stable release) and open a new one for the next minor release

‎bin/internal/set-version.sh‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,15 @@ fi
4949
# for instance), and while that's more precise this should work with less to fix if a line changes.
5050
# This method wasn't selected for any particular strength.
5151

52-
oldVersion="$(grep 'version =' "${dir}"doc/conf.py | cut -d "'" -f2)"
52+
oldVersion="$(grep 'version =' "${dir}"docs/conf.py | cut -d "'" -f2)"
5353

5454
echo "Changing from ${oldVersion} to ${newVersion}..."
5555

5656
# Escape the dot for sed
5757
oldVersion=${oldVersion//./\.}
5858
newVersion=${newVersion//./\.}
5959

60-
for f in README doc/conf.py package.json
60+
for f in README docs/conf.py package.json
6161
do
6262
if ! grep --quiet "${oldVersion}" "${dir}${f}"
6363
then

‎config.sample.inc.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* phpMyAdmin sample configuration, you can use it as base for
44
* manual configuration. For easier setup you can use setup/
55
*
6-
* All directives are explained in documentation in the doc/ folder
6+
* All directives are explained in documentation in the docs/ folder
77
* or at <https://docs.phpmyadmin.net/>.
88
*/
99

@@ -156,5 +156,5 @@
156156

157157
/**
158158
* You can find more configuration options in the documentation
159-
* in the doc/ folder or at <https://docs.phpmyadmin.net/>.
159+
* in the docs/ folder or at <https://docs.phpmyadmin.net/>.
160160
*/

doc/.gitignore renamed to docs/.gitignore

File renamed without changes.

doc/Makefile renamed to docs/Makefile

File renamed without changes.

0 commit comments

Comments
 (0)