mirrors/coreutils
1
0
Fork 0
mirror of https://github.com/uutils/coreutils.git synced 2025-07-07 21:45:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

refactor ~ (docs) fix spelling + add spell-checker exceptions

Browse source
This commit is contained in:
Roy Ivy III 2021-05-30 21:58:57 -05:00
parent 06c53d97fc
commit 0b20997d10
6 changed files with 20 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/GNUmakefile
View file

@ -1,5 +1,6 @@
# spell-checker:ignore (vars/env) SPHINXOPTS SPHINXBUILD SPHINXPROJ SOURCEDIR BUILDDIR
# Minimal makefile for Sphinx documentation # Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line. # You can set these variables from the command line.
SPHINXOPTS = SPHINXOPTS =

6
docs/Makefile
View file

@ -1,5 +1,5 @@
USEGNU=gmake $* UseGNU=gmake $*
all: all:
@$(USEGNU) @$(UseGNU)
.DEFAULT: .DEFAULT:
@$(USEGNU) @$(UseGNU)

4
docs/compiles_table.py
View file

@ -10,6 +10,8 @@ from pathlib import Path
# third party dependencies # third party dependencies
from tqdm import tqdm from tqdm import tqdm
# spell-checker:ignore (libs) tqdm imap ; (shell/mac) xcrun ; (vars) nargs
BINS_PATH=Path("../src/uu") BINS_PATH=Path("../src/uu")
CACHE_PATH=Path("compiles_table.csv") CACHE_PATH=Path("compiles_table.csv")
TARGETS = [ TARGETS = [
@ -50,7 +52,7 @@ TARGETS = [
class Target(str): class Target(str):
def __new__(cls, content): def __new__(cls, content):
obj = super().__new__(cls, content) obj = super().__new__(cls, content)
obj.arch, obj.platfrom, obj.os = Target.parse(content) obj.arch, obj.platform, obj.os = Target.parse(content)
return obj return obj
@staticmethod @staticmethod

4
docs/conf.py
View file

@ -21,6 +21,8 @@
# import sys # import sys
# sys.path.insert(0, os.path.abspath('.')) # sys.path.insert(0, os.path.abspath('.'))
# spell-checker:ignore (words) howto htbp imgmath toctree todos uutilsdoc
import glob import glob
import os import os
import re import re
@ -180,6 +182,6 @@ for name in glob.glob('*.rst'):
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'uutils', 'uutils Documentation', (master_doc, 'uutils', 'uutils Documentation',
author, 'uutils', 'A cross-platform reimplementation of GNU coreutils in Rust.', author, 'uutils', 'A cross-platform implementation of GNU coreutils, written in Rust.',
'Miscellaneous'), 'Miscellaneous'),
] ]

7
docs/index.rst
View file

@ -3,8 +3,11 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to uutils's documentation! ..
================================== spell-checker:ignore (directives) genindex maxdepth modindex toctree ; (misc) quickstart
Welcome to uutils' documentation!
=================================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

5
docs/make.bat
View file

@ -1,5 +1,8 @@
@setLocal
@ECHO OFF @ECHO OFF
rem spell-checker:ignore (vars/env) BUILDDIR SOURCEDIR SPHINXBUILD SPHINXOPTS SPHINXPROJ
pushd %~dp0 pushd %~dp0
REM Command file for Sphinx documentation REM Command file for Sphinx documentation
@ -14,7 +17,7 @@ set SPHINXPROJ=uutils
if "%1" == "" goto help if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL %SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 ( if ErrorLevel 9009 (
echo. echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point echo.installed, then set the SPHINXBUILD environment variable to point