Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Warnings when building the documentation #323

Open
Jayman2000 opened this issue Dec 12, 2023 · 0 comments
Open

Warnings when building the documentation #323

Jayman2000 opened this issue Dec 12, 2023 · 0 comments

Comments

@Jayman2000
Copy link

Steps to reproduce

  1. Make sure that your current working directory is a clone of this repository.

  2. Create a virtual environment:

    python -m venv venv
  3. Activate the virtual environment:

    source venv/bin/activate
  4. (Optional) Update pip:

    python -m pip install --upgrade pip
  5. Install the dependencies for building the docs:

    pip install . sphinx matplotlib
  6. Switch to the doc: directory:

    cd doc
  7. Build the docs:

    make html

Results

When I follow those instructions, I get two warnings:

pygame 2.5.2 (SDL 2.28.2, Python 3.12.0)
Hello from the pygame community. https://www.pygame.org/contribute.html
pygame 2.5.2 (SDL 2.28.2, Python 3.12.0)
Hello from the pygame community. https://www.pygame.org/contribute.html
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v7.2.6
WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English).
making output directory... done
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 17 source files that are out of date
updating environment: [new config] 17 added, 0 changed, 0 removed
reading sources... [100%] stickers
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [100%] stickers
/hdd/home/jayman/VC/Git/Partially mine/pgzero/repo/doc/changelog.rst:10: WARNING: unknown document: 'repl'
generating indices... genindex done
writing additional pages... search done
copying images... [100%] _static/sticker-mockup.svg
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 2 warnings.

The HTML pages are in _build/html.

Build finished. The HTML pages are in _build/html.

System information

I’m running Python 3.12.0 on NixOS 23.11.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant