[Ovmsdev] ReadTheDocs plugin needed

Mark Webb-Johnson mark at webb-johnson.net
Thu Oct 31 08:10:12 HKT 2019


Fought with the readthedocs.yaml file for a while, but gave up. In the end, I added a requirements.txt file to list pip requirements, and added that to the readthedocs config (web interface). That seems to build now:

Collecting m2r (from -r docs/source/requirements.txt (line 1))
  Downloading https://files.pythonhosted.org/packages/39/e7/9fae11a45f5e1a3a21d8a98d02948e597c4afd7848a0dbe1a1ebd235f13e/m2r-0.2.1.tar.gz
Collecting mistune (from m2r->-r docs/source/requirements.txt (line 1))
  Downloading https://files.pythonhosted.org/packages/09/ec/4b43dae793655b7d8a25f76119624350b4d65eb663459eb9603d7f1f0345/mistune-0.8.4-py2.py3-none-any.whl
Requirement already satisfied: docutils in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.7/site-packages (from m2r->-r docs/source/requirements.txt (line 1)) (0.14)
Building wheels for collected packages: m2r
  Building wheel for m2r (setup.py): started
  Building wheel for m2r (setup.py): finished with status 'done'
  Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/ovms/.cache/pip/wheels/47/f8/dc/80f56bc4abf785834d422c2f5c864a14bf34576612aeb03492
Successfully built m2r
Installing collected packages: mistune, m2r
Successfully installed m2r-0.2.1 mistune-0.8.4

Regards, Mark.

> On 31 Oct 2019, at 6:31 AM, Michael Balzer <dexter at expeedo.de> wrote:
> Mark,
> I've pushed the change to include the README.md as the introduction page into the user guide.
> This change needs the sphinx plugin "m2r", which seems to require a change to the RTD configuration -- the build currently fails:
> https://readthedocs.org/projects/ovms/builds/9887081/
> It seems you need to add the plugin manually in the RTD web interface. To avoid that, the RTD systems supports build configurations in the source tree, maybe
> that's a better option:
> https://docs.readthedocs.io/en/latest/config-file/index.html
> Regards,
> Michael
> -- 
> Michael Balzer * Helkenberger Weg 9 * D-58256 Ennepetal
> Fon 02333 / 833 5735 * Handy 0176 / 206 989 26
> _______________________________________________
> OvmsDev mailing list
> OvmsDev at lists.openvehicles.com
> http://lists.openvehicles.com/mailman/listinfo/ovmsdev

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openvehicles.com/pipermail/ovmsdev/attachments/20191031/cfc343e0/attachment.htm>

More information about the OvmsDev mailing list