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

Errors when building locally #186

Open
kashyl opened this issue Jan 9, 2025 · 3 comments
Open

Errors when building locally #186

kashyl opened this issue Jan 9, 2025 · 3 comments

Comments

@kashyl
Copy link
Contributor

kashyl commented Jan 9, 2025

Hi!
I've been following the instructions in 29. Developing in django-formset to build the library locally, but I've encountered a few issues along the way. Some of these are minor and might benefit from documentation updates, while one is currently blocking me. Here’s a summary:

Documentation Suggestions:

  1. For setting DJANGO_DEBUG:

    • On Unix/Git Bash: export DJANGO_DEBUG=true
    • On Windows CMD: set DJANGO_DEBUG=true
      Maybe both variants should be added for clarity?
  2. Activating the virtual environment in Windows CMD:

    • call .venv/Scripts/Activate (since .venv starts with a dot).

Steps Taken

  1. The sphinx-build command was not recognized. I resolved this by running:

    • pip install -U sphinx
  2. Additional dependencies were required:

    • pip install sphinx-toolbox
    • pip install furo
  3. Current Blocking Issue:
    When running the sphinx-build command, I encountered the following error:

    Extension error (sphinx_view.builders):
    Handler <function process_django_views at 0x000001A1ECA41120> for event 'env-updated' threw an exception (exception: 'charmap' codec can't encode character '\u03a9' in position 493: character maps to <undefined>)
    

On a first glance it eems the error is related to the character \u03a9 (Greek capital omega), though I’ve reviewed docs/source and sphinx_view code but couldn't pinpoint the root cause.

@jrief
Copy link
Owner

jrief commented Jan 17, 2025

When running the sphinx-build command, I encountered the following error:

This is weird. Without more context it's impossible to explain this. Please try to create the deployable project using the Docker file provided in .deployment.

@Alex-Sichkar
Copy link

Alex-Sichkar commented Jan 20, 2025

I was able to build the docs after installing additional dependencies (sphinx, sphinx-toolbox, furo), but I could not run the app:

Image

@Alex-Sichkar
Copy link

I managed to build and run with the following fixes to the docs steps:

sphinx-build -M json docs/source build > sphinx-build -M json docs/source docs/build

To run it, in my case, I had to change the working directory to testapp and run ./manage.py from there.

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

3 participants