1
0
mirror of https://github.com/uutils/coreutils synced 2024-07-01 06:54:36 +00:00

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

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

View File

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

View File

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

View File

@ -10,6 +10,8 @@ from pathlib import Path
# third party dependencies
from tqdm import tqdm
# spell-checker:ignore (libs) tqdm imap ; (shell/mac) xcrun ; (vars) nargs
BINS_PATH=Path("../src/uu")
CACHE_PATH=Path("compiles_table.csv")
TARGETS = [
@ -50,7 +52,7 @@ TARGETS = [
class Target(str):
def __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
@staticmethod

View File

@ -21,6 +21,8 @@
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# spell-checker:ignore (words) howto htbp imgmath toctree todos uutilsdoc
import glob
import os
import re
@ -180,6 +182,6 @@ for name in glob.glob('*.rst'):
# dir menu entry, description, category)
texinfo_documents = [
(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'),
]

View File

@ -3,8 +3,11 @@
You can adapt this file completely to your liking, but it should at least
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::
:maxdepth: 2

View File

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