search

OP-TEE / optee_docs

This git contains the official documentation for the OP-TEE project
BSD 2-Clause "Simplified" License
58 stars 96 forks source link

Testing with Plantuml #118

Closed jenswi-linaro closed 3 years ago

jenswi-linaro commented 3 years ago

@gyuri-szing, can you see what's wrong in the python 3.6 case?

jenswi-linaro commented 3 years ago

Trying to setup the plantuml stuff needed by https://github.com/OP-TEE/optee_docs/pull/107 with this PR.

gyuri-szing commented 3 years ago

@gyuri-szing, can you see what's wrong in the python 3.6 case?

Pip seems to encounter an error:

...
Successfully built sphinxcontrib-plantuml

ERROR: sphinx-rtd-theme 0.5.2 has requirement docutils<0.17, but you'll have docutils 0.17.1 which is incompatible.

Even though it returns with success, perhaps installing the packages still fails.

[EDIT] The successful 2.7 run has the exact same error. There was a suspicious issue with sphinxcontrib.plantuml reported here: https://github.com/sphinx-contrib/plantuml/issues/56 a fix was merged, but no release contains is yet. Can you downgrade Sphinx to 3.x?

jenswi-linaro commented 3 years ago

Thanks @gyuri-szing, I'll try.

jenswi-linaro commented 3 years ago

Hah, that downgrading sphinx worked for python 3.6 but not for python 2.7. I guess I'll need a way to select version of sphinx based on python version.

jenswi-linaro commented 3 years ago

By the way, @jbech-linaro why are we using python 2.7 at all?

jbech-linaro commented 3 years ago

By the way, @jbech-linaro why are we using python 2.7 at all?

No, not any longer, feel free to remove 2.7 support (and the 2.7 build we're doing using Travis).

jenswi-linaro commented 3 years ago

By the way, @jbech-linaro why are we using python 2.7 at all?

No, not any longer, feel free to remove 2.7 support (and the 2.7 build we're doing using Travis).

OK, thanks. This PR works with Travis as it is right now. I believe the easiest way forward is to merge this PR. We wait until the fix for https://github.com/sphinx-contrib/plantuml/issues/56 is released and then remove the workarounds and possibly the python 2.7 stuff. How does that sound?

It seems that readthedocs already have plantuml support so the update in conf.py should be the only thing needed to activate that plugin. I guess we'll only know for sure once this PR is merged.

jenswi-linaro commented 3 years ago

Tag applied

jbech-linaro commented 3 years ago

@jenswi-linaro ReadTheDocs didn't like this change: https://readthedocs.org/projects/optee/builds/13733786/

jbech-linaro commented 3 years ago

I noticed it built it using 2.7 by default, so I changed it to 3.x instead. However, same issue. But I also noticed that we can point to a requirements file (from the RTD admin page). Maybe that would do the trick. I.e., create a requirements file where we state the dependencies.

jenswi-linaro commented 3 years ago

Yes, we should try that. I believe that currently you're the only one that can access the RTD admin page. I can't find it at least.

jbech-linaro commented 3 years ago

I've just created #119, let's see if that will sort it out.