From cd69103b8b37338583cd3aa1d02e9d96106a15f1 Mon Sep 17 00:00:00 2001 From: Myk Taylor Date: Wed, 30 Nov 2022 04:13:21 -0800 Subject: [PATCH] update path references, move NEWS files back --- ci/authors-rst.py | 4 ++-- ci/lint-ignore.txt | 7 ++++++- docs/{dev => }/NEWS-dev.rst | 0 docs/{about => }/NEWS.rst | 0 docs/about/index.rst | 2 +- docs/changelog.txt | 2 +- docs/dev/Contributing.rst | 2 +- docs/dev/index.rst | 2 +- 8 files changed, 12 insertions(+), 7 deletions(-) rename docs/{dev => }/NEWS-dev.rst (100%) rename docs/{about => }/NEWS.rst (100%) diff --git a/ci/authors-rst.py b/ci/authors-rst.py index 076f7f226..b9ef48d7c 100755 --- a/ci/authors-rst.py +++ b/ci/authors-rst.py @@ -11,9 +11,9 @@ def main(): info += ' %s %s:' % (k, kwargs[k]) print('line %i:%s %s' % (line, info, msg)) if os.environ.get('GITHUB_ACTIONS'): - print('::error file=docs/Authors.rst,line=%i::%s %s' % (line, info.lstrip(), msg)) + print('::error file=docs/about/Authors.rst,line=%i::%s %s' % (line, info.lstrip(), msg)) success[0] = False - with open('docs/Authors.rst', 'rb') as f: + with open('docs/about/Authors.rst', 'rb') as f: lines = list(map(lambda line: line.decode('utf8').replace('\n', ''), f.readlines())) if lines[1].startswith('='): diff --git a/ci/lint-ignore.txt b/ci/lint-ignore.txt index d384b80f3..c8c40c82b 100644 --- a/ci/lint-ignore.txt +++ b/ci/lint-ignore.txt @@ -10,9 +10,14 @@ plugins/stonesense/*.txt # Generated files *.pb.h build*/* -docs/_* +docs/changelogs/* docs/html/* docs/pdf/* +docs/pseudoxml/* +docs/tags/* +docs/text/* +docs/tools/* +docs/xml/* library/include/df/* # Dependencies that we don't control diff --git a/docs/dev/NEWS-dev.rst b/docs/NEWS-dev.rst similarity index 100% rename from docs/dev/NEWS-dev.rst rename to docs/NEWS-dev.rst diff --git a/docs/about/NEWS.rst b/docs/NEWS.rst similarity index 100% rename from docs/about/NEWS.rst rename to docs/NEWS.rst diff --git a/docs/about/index.rst b/docs/about/index.rst index 1ff09182d..e8dede969 100644 --- a/docs/about/index.rst +++ b/docs/about/index.rst @@ -10,4 +10,4 @@ These pages contain information about the general DFHack project. /docs/about/Authors /LICENSE /docs/about/Removed - /docs/about/NEWS + /docs/NEWS diff --git a/docs/changelog.txt b/docs/changelog.txt index 49a5eee0b..e3eb2ec51 100644 --- a/docs/changelog.txt +++ b/docs/changelog.txt @@ -1,7 +1,7 @@ === Scroll down for changes ===[[[ -The text below is included in docs/Documentation.rst - see that file for more details on the changelog setup. +The text below is included in docs/dev/Documentation.rst - see that file for more details on the changelog setup. This is kept in this file as a quick syntax reference. ===help diff --git a/docs/dev/Contributing.rst b/docs/dev/Contributing.rst index 799a420a5..f503d9126 100644 --- a/docs/dev/Contributing.rst +++ b/docs/dev/Contributing.rst @@ -92,7 +92,7 @@ General contribution guidelines compiles. Our CI should catch anything that fails to build, but checking in advance can sometimes let you know of any issues sooner. * Update documentation when applicable - see `docs-standards` for details. -* Update ``changelog.txt`` and ``docs/Authors.rst`` when applicable. See +* Update ``docs/changelog.txt`` and ``docs/about/Authors.rst`` when applicable. See `build-changelog` for more information on the changelog format. * Submit ideas and bug reports as :issue:`issues on GitHub <>`. Posts in the forum thread can easily get missed or forgotten. diff --git a/docs/dev/index.rst b/docs/dev/index.rst index d88b4b425..26d094ec8 100644 --- a/docs/dev/index.rst +++ b/docs/dev/index.rst @@ -18,4 +18,4 @@ These are pages relevant to people developing for DFHack. /docs/dev/Memory-research /docs/dev/Binpatches /docs/dev/Remote - /docs/dev/NEWS-dev + /docs/NEWS-dev