From f1fd0c975afc8df6adb3bb90e159604eaf4d40c5 Mon Sep 17 00:00:00 2001 From: Alessandro Comodi Date: Tue, 24 Sep 2019 11:49:00 +0200 Subject: [PATCH] docs: removed src directory to have working readthedocs build Signed-off-by: Alessandro Comodi --- docs/.gitignore | 4 ++-- docs/Makefile | 18 +++++++++--------- .../architecture/bitstream_format.rst | 0 docs/architecture/code_of_conduct.md | 1 + docs/{src => }/architecture/configuration.rst | 0 docs/architecture/copying.md | 1 + .../architecture/dram_configuration.rst | 0 docs/{src => }/architecture/glossary.rst | 0 docs/{src => }/architecture/interconnect.rst | 0 docs/{src => }/architecture/overview.rst | 0 docs/{src => }/architecture/reference.rst | 0 docs/architecture/updating_the_docs.md | 1 + docs/conf.py | 2 +- docs/db_dev_process/contributing.md | 1 + docs/db_dev_process/fuzzers/index | 1 + .../{src => }/db_dev_process/fuzzers/index.rst | 0 docs/db_dev_process/minitests/index | 1 + .../db_dev_process/minitests/index.rst | 1 - docs/{src => }/db_dev_process/parts.rst | 0 docs/db_dev_process/readme.md | 1 + docs/{src => }/format/db.rst | 0 docs/{src => }/format/tile.rst | 0 docs/{src => }/index.rst | 0 docs/src/architecture/code_of_conduct.md | 1 - docs/src/architecture/copying.md | 1 - docs/src/architecture/updating_the_docs.md | 1 - docs/src/db_dev_process/contributing.md | 1 - docs/src/db_dev_process/fuzzers/index | 1 - docs/src/db_dev_process/minitests/index | 1 - docs/src/db_dev_process/readme.md | 1 - 30 files changed, 19 insertions(+), 20 deletions(-) rename docs/{src => }/architecture/bitstream_format.rst (100%) create mode 120000 docs/architecture/code_of_conduct.md rename docs/{src => }/architecture/configuration.rst (100%) create mode 120000 docs/architecture/copying.md rename docs/{src => }/architecture/dram_configuration.rst (100%) rename docs/{src => }/architecture/glossary.rst (100%) rename docs/{src => }/architecture/interconnect.rst (100%) rename docs/{src => }/architecture/overview.rst (100%) rename docs/{src => }/architecture/reference.rst (100%) create mode 120000 docs/architecture/updating_the_docs.md create mode 120000 docs/db_dev_process/contributing.md create mode 120000 docs/db_dev_process/fuzzers/index rename docs/{src => }/db_dev_process/fuzzers/index.rst (100%) create mode 120000 docs/db_dev_process/minitests/index rename docs/{src => }/db_dev_process/minitests/index.rst (97%) rename docs/{src => }/db_dev_process/parts.rst (100%) create mode 120000 docs/db_dev_process/readme.md rename docs/{src => }/format/db.rst (100%) rename docs/{src => }/format/tile.rst (100%) rename docs/{src => }/index.rst (100%) delete mode 120000 docs/src/architecture/code_of_conduct.md delete mode 120000 docs/src/architecture/copying.md delete mode 120000 docs/src/architecture/updating_the_docs.md delete mode 120000 docs/src/db_dev_process/contributing.md delete mode 120000 docs/src/db_dev_process/fuzzers/index delete mode 120000 docs/src/db_dev_process/minitests/index delete mode 120000 docs/src/db_dev_process/readme.md diff --git a/docs/.gitignore b/docs/.gitignore index c8d939ef..9d7ce536 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,3 +1,3 @@ _build -src/db_dev_process/fuzzers/*.md -src/db_dev_process/minitests/*.md +db_dev_process/fuzzers/*.md +db_dev_process/minitests/*.md diff --git a/docs/Makefile b/docs/Makefile index 02bebc6c..d845e77b 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -8,7 +8,7 @@ SPHINXOPTS = SPHINXBUILD = sphinx-build SPHINXAUTOBUILD = sphinx-autobuild SPHINXPROJ = ProjectX-Ray -SOURCEDIR = src +SOURCEDIR = . BUILDDIR = _build # Put it first so that "make" without argument is like "make help". @@ -22,10 +22,10 @@ livehtml: # Update fuzzer / minitest markdown links. fuzzers-links: - @mkdir -p $(MAKEDIR)/${SOURCEDIR}/db_dev_process/fuzzers - @cd $(MAKEDIR)/${SOURCEDIR}/db_dev_process/fuzzers && rm -f *.md - @cd $(MAKEDIR)/${SOURCEDIR}/db_dev_process/fuzzers && \ - for i in ../../../../fuzzers/*; do \ + @mkdir -p $(MAKEDIR)/db_dev_process/fuzzers + @cd $(MAKEDIR)/db_dev_process/fuzzers && rm -f *.md + @cd $(MAKEDIR)/db_dev_process/fuzzers && \ + for i in ../../../fuzzers/*; do \ n=$$(basename $$i | sed -e's/^[0-9][0-9][0-9]-//'); \ if [ ! -d $$i ]; then \ continue; \ @@ -42,10 +42,10 @@ fuzzers-links: done minitests-links: - @mkdir -p $(MAKEDIR)/${SOURCEDIR}/db_dev_process/minitests - @cd $(MAKEDIR)/${SOURCEDIR}/db_dev_process/minitests && rm -f *.md - @cd $(MAKEDIR)/${SOURCEDIR}/db_dev_process/minitests && \ - for i in ../../../../minitests/*; do \ + @mkdir -p $(MAKEDIR)/db_dev_process/minitests + @cd $(MAKEDIR)/db_dev_process/minitests && rm -f *.md + @cd $(MAKEDIR)/db_dev_process/minitests && \ + for i in ../../../minitests/*; do \ n=$$(basename $$i | sed -e's/^[0-9][0-9][0-9]-//'); \ if [ ! -d $$i ]; then \ continue; \ diff --git a/docs/src/architecture/bitstream_format.rst b/docs/architecture/bitstream_format.rst similarity index 100% rename from docs/src/architecture/bitstream_format.rst rename to docs/architecture/bitstream_format.rst diff --git a/docs/architecture/code_of_conduct.md b/docs/architecture/code_of_conduct.md new file mode 120000 index 00000000..a3613c99 --- /dev/null +++ b/docs/architecture/code_of_conduct.md @@ -0,0 +1 @@ +../../CODE_OF_CONDUCT.md \ No newline at end of file diff --git a/docs/src/architecture/configuration.rst b/docs/architecture/configuration.rst similarity index 100% rename from docs/src/architecture/configuration.rst rename to docs/architecture/configuration.rst diff --git a/docs/architecture/copying.md b/docs/architecture/copying.md new file mode 120000 index 00000000..7d29222e --- /dev/null +++ b/docs/architecture/copying.md @@ -0,0 +1 @@ +../../COPYING \ No newline at end of file diff --git a/docs/src/architecture/dram_configuration.rst b/docs/architecture/dram_configuration.rst similarity index 100% rename from docs/src/architecture/dram_configuration.rst rename to docs/architecture/dram_configuration.rst diff --git a/docs/src/architecture/glossary.rst b/docs/architecture/glossary.rst similarity index 100% rename from docs/src/architecture/glossary.rst rename to docs/architecture/glossary.rst diff --git a/docs/src/architecture/interconnect.rst b/docs/architecture/interconnect.rst similarity index 100% rename from docs/src/architecture/interconnect.rst rename to docs/architecture/interconnect.rst diff --git a/docs/src/architecture/overview.rst b/docs/architecture/overview.rst similarity index 100% rename from docs/src/architecture/overview.rst rename to docs/architecture/overview.rst diff --git a/docs/src/architecture/reference.rst b/docs/architecture/reference.rst similarity index 100% rename from docs/src/architecture/reference.rst rename to docs/architecture/reference.rst diff --git a/docs/architecture/updating_the_docs.md b/docs/architecture/updating_the_docs.md new file mode 120000 index 00000000..32e89853 --- /dev/null +++ b/docs/architecture/updating_the_docs.md @@ -0,0 +1 @@ +../../UPDATING-THE-DOCS.md \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 7137c4a2..3761d887 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -200,7 +200,7 @@ def setup(app): github_code_branch = 'blob/master/' docs_root_dir = os.path.realpath(os.path.dirname(__file__)) - code_root_dir = os.path.realpath(os.path.join(docs_root_dir, "..", "..")) + code_root_dir = os.path.realpath(os.path.join(docs_root_dir, "..")) MarkdownSymlinksDomain.init_domain( github_code_repo, github_code_branch, docs_root_dir, code_root_dir) diff --git a/docs/db_dev_process/contributing.md b/docs/db_dev_process/contributing.md new file mode 120000 index 00000000..f939e75f --- /dev/null +++ b/docs/db_dev_process/contributing.md @@ -0,0 +1 @@ +../../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/db_dev_process/fuzzers/index b/docs/db_dev_process/fuzzers/index new file mode 120000 index 00000000..76076bf2 --- /dev/null +++ b/docs/db_dev_process/fuzzers/index @@ -0,0 +1 @@ +../../../fuzzers/ \ No newline at end of file diff --git a/docs/src/db_dev_process/fuzzers/index.rst b/docs/db_dev_process/fuzzers/index.rst similarity index 100% rename from docs/src/db_dev_process/fuzzers/index.rst rename to docs/db_dev_process/fuzzers/index.rst diff --git a/docs/db_dev_process/minitests/index b/docs/db_dev_process/minitests/index new file mode 120000 index 00000000..40e60221 --- /dev/null +++ b/docs/db_dev_process/minitests/index @@ -0,0 +1 @@ +../../../minitests/ \ No newline at end of file diff --git a/docs/src/db_dev_process/minitests/index.rst b/docs/db_dev_process/minitests/index.rst similarity index 97% rename from docs/src/db_dev_process/minitests/index.rst rename to docs/db_dev_process/minitests/index.rst index 2e06adb6..d97f6ba8 100644 --- a/docs/src/db_dev_process/minitests/index.rst +++ b/docs/db_dev_process/minitests/index.rst @@ -14,7 +14,6 @@ Minitests are experiments to figure out how things work. They allow us to unders clkbuf eccbits fixedpnr - index.rst litex lvb_long_mux nodes_wires_list diff --git a/docs/src/db_dev_process/parts.rst b/docs/db_dev_process/parts.rst similarity index 100% rename from docs/src/db_dev_process/parts.rst rename to docs/db_dev_process/parts.rst diff --git a/docs/db_dev_process/readme.md b/docs/db_dev_process/readme.md new file mode 120000 index 00000000..fe840054 --- /dev/null +++ b/docs/db_dev_process/readme.md @@ -0,0 +1 @@ +../../README.md \ No newline at end of file diff --git a/docs/src/format/db.rst b/docs/format/db.rst similarity index 100% rename from docs/src/format/db.rst rename to docs/format/db.rst diff --git a/docs/src/format/tile.rst b/docs/format/tile.rst similarity index 100% rename from docs/src/format/tile.rst rename to docs/format/tile.rst diff --git a/docs/src/index.rst b/docs/index.rst similarity index 100% rename from docs/src/index.rst rename to docs/index.rst diff --git a/docs/src/architecture/code_of_conduct.md b/docs/src/architecture/code_of_conduct.md deleted file mode 120000 index 5d525cd1..00000000 --- a/docs/src/architecture/code_of_conduct.md +++ /dev/null @@ -1 +0,0 @@ -../../../CODE_OF_CONDUCT.md \ No newline at end of file diff --git a/docs/src/architecture/copying.md b/docs/src/architecture/copying.md deleted file mode 120000 index 28b80bcc..00000000 --- a/docs/src/architecture/copying.md +++ /dev/null @@ -1 +0,0 @@ -../../../COPYING \ No newline at end of file diff --git a/docs/src/architecture/updating_the_docs.md b/docs/src/architecture/updating_the_docs.md deleted file mode 120000 index 22d86c5d..00000000 --- a/docs/src/architecture/updating_the_docs.md +++ /dev/null @@ -1 +0,0 @@ -../../../UPDATING-THE-DOCS.md \ No newline at end of file diff --git a/docs/src/db_dev_process/contributing.md b/docs/src/db_dev_process/contributing.md deleted file mode 120000 index c97564d9..00000000 --- a/docs/src/db_dev_process/contributing.md +++ /dev/null @@ -1 +0,0 @@ -../../../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/src/db_dev_process/fuzzers/index b/docs/src/db_dev_process/fuzzers/index deleted file mode 120000 index d78a6674..00000000 --- a/docs/src/db_dev_process/fuzzers/index +++ /dev/null @@ -1 +0,0 @@ -../../../../fuzzers/ \ No newline at end of file diff --git a/docs/src/db_dev_process/minitests/index b/docs/src/db_dev_process/minitests/index deleted file mode 120000 index 353e56d0..00000000 --- a/docs/src/db_dev_process/minitests/index +++ /dev/null @@ -1 +0,0 @@ -../../../../minitests/ \ No newline at end of file diff --git a/docs/src/db_dev_process/readme.md b/docs/src/db_dev_process/readme.md deleted file mode 120000 index 8a33348c..00000000 --- a/docs/src/db_dev_process/readme.md +++ /dev/null @@ -1 +0,0 @@ -../../../README.md \ No newline at end of file