[GSOC23] Render Engine Docs

[BharatSahlot]

I want to write more detailed docs for the rendering process and cobra engine. Where should I put it? The Code Structure section doesn't seem appropriate, because I will be explaining both the algorithm and the code, and the page will become really long.

[ice0]

You can split it into pages however you like, if you think it will be more readable.

[BharatSahlot]

Okay

[BharatSahlot]

I was running the installation commands from the Readme.md.

$ sudo pip3 install pipenv
$ cd docs
$ pipenv install --three # getting error here

But I am getting this error

Installing --three...
Resolving --three...
Traceback (most recent call last):
  File "/usr/local/lib/python3.10/site-packages/pipenv/patched/pip/_vendor/packaging/requirements.py", line 102, in __init__
    req = REQUIREMENT.parseString(requirement_string)
  File "/usr/local/lib/python3.10/site-packages/pipenv/patched/pip/_vendor/pyparsing/core.py", line 1141, in parse_string
    raise exc.with_traceback(None)
pipenv.patched.pip._vendor.pyparsing.exceptions.ParseException: Expected W:(0-9A-Za-z), found '-'  (at char 0), (line:1, col:1)

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/usr/local/lib/python3.10/site-packages/pipenv/vendor/requirementslib/models/requirements.py", line 965, in _parse_name_from_line
    self._requirement = init_requirement(self.line)
  File "/usr/local/lib/python3.10/site-packages/pipenv/vendor/requirementslib/models/utils.py", line 191, in init_requirement
    req = Requirement.parse(name)
  File "/usr/local/lib/python3.10/site-packages/pipenv/patched/pip/_vendor/pkg_resources/__init__.py", line 3214, in parse
    (req,) = parse_requirements(s)
  File "/usr/local/lib/python3.10/site-packages/pipenv/patched/pip/_vendor/pkg_resources/__init__.py", line 3173, in __init__
    super(Requirement, self).__init__(requirement_string)
  File "/usr/local/lib/python3.10/site-packages/pipenv/patched/pip/_vendor/packaging/requirements.py", line 104, in __init__
    raise InvalidRequirement(
pipenv.patched.pip._vendor.packaging.requirements.InvalidRequirement: Parse error at "'--three'": Expected W:(0-9A-Za-z)

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/usr/local/bin/pipenv", line 8, in <module>
    sys.exit(cli())
  File "/usr/local/lib/python3.10/site-packages/pipenv/vendor/click/core.py", line 1130, in __call__
    return self.main(*args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/pipenv/cli/options.py", line 58, in main
    return super().main(*args, **kwargs, windows_expand_args=False)
  File "/usr/local/lib/python3.10/site-packages/pipenv/vendor/click/core.py", line 1055, in main
    rv = self.invoke(ctx)
  File "/usr/local/lib/python3.10/site-packages/pipenv/vendor/click/core.py", line 1657, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/local/lib/python3.10/site-packages/pipenv/vendor/click/core.py", line 1404, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/local/lib/python3.10/site-packages/pipenv/vendor/click/core.py", line 760, in invoke
    return __callback(*args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/pipenv/vendor/click/decorators.py", line 84, in new_func
    return ctx.invoke(f, obj, *args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/pipenv/vendor/click/core.py", line 760, in invoke
    return __callback(*args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/pipenv/cli/command.py", line 235, in install
    do_install(
  File "/usr/local/lib/python3.10/site-packages/pipenv/routines/install.py", line 250, in do_install
    pkg_requirement = Requirement.from_line(pkg_line)
  File "/usr/local/lib/python3.10/site-packages/pipenv/vendor/requirementslib/models/requirements.py", line 2678, in from_line
    parsed_line = Line(line)
  File "/usr/local/lib/python3.10/site-packages/pipenv/vendor/requirementslib/models/requirements.py", line 172, in __init__
    self.parse()
  File "/usr/local/lib/python3.10/site-packages/pipenv/vendor/requirementslib/models/requirements.py", line 1301, in parse
    self.parse_name()
  File "/usr/local/lib/python3.10/site-packages/pipenv/vendor/requirementslib/models/requirements.py", line 1026, in parse_name
    name = self._parse_name_from_line()
  File "/usr/local/lib/python3.10/site-packages/pipenv/vendor/requirementslib/models/requirements.py", line 967, in _parse_name_from_line
    raise RequirementError(
pipenv.vendor.requirementslib.exceptions.RequirementError: Failed parsing requirement from '--three'

[veermetri05]

I think the Readme is outdated, you can install Sphinx by following official documentation and run make html in docs folder.

[BharatSahlot]

It worked! Thanks @veermetri05. I had to run these two commands as well.

pip install recommonmark
pip install sphinx-rtd-theme

[Keyikedalube]

Exact error #101 (comment) on my side here too

At the bottom of the message --three argument seem to cause the error so I did

pipenv install

without the argument and it worked. Takes some time locking Pipfile.lock and installing dependencies.

[veermetri05]

@BharatSahlot If you need any help for creating illustrations/diagrams for the documentation, feel free to ping me.

[BharatSahlot]

Thanks @veermetri05 . I didn't really think about diagrams till now, but now that you mention it, I think they can help. I will let you know if I need one.