All of lore.kernel.org
 help / color / mirror / Atom feed
From: shantanoo.desai@gmail.com
To: docs@lists.yoctoproject.org
Subject: Re: [PATCH] documentation: Add Pipenv support
Date: Wed, 11 Nov 2020 13:30:10 -0800	[thread overview]
Message-ID: <27534.1605130210340595078@lists.yoctoproject.org> (raw)
In-Reply-To: <20201110212917.25172-1-JPEWhacker@gmail.com>

[-- Attachment #1: Type: text/plain, Size: 692 bytes --]

Hi Joshua,

I would suggest adding [sphinx-serve](https://pypi.org/project/sphinx-serve/) as a dev-package to serve the docs during local development/tests.

I was able to serve the Sphinx-RTD on my machine simply by executing `sphinx-serve` in the `documentations/` folder. Maybe mention it in the README too?.

I think Pipenv might be required since I was digging into the Algolia Search Indexing and there you can use their document scraper with Pipenv as well.
(see https://docsearch.algolia.com/docs/run-your-own/)

Might be worth the effort, since Nico did mention plans to use an indexing search for the new docs.

Would love your thoughts on this.

Regards,

Shan



[-- Attachment #2: Type: text/html, Size: 872 bytes --]

  reply	other threads:[~2020-11-11 21:30 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-10 21:29 [docs][PATCH] documentation: Add Pipenv support Joshua Watt
2020-11-11 21:30 ` shantanoo.desai [this message]
2020-11-11 22:05   ` [docs] [PATCH] " Joshua Watt
2020-11-12  7:29     ` Nicolas Dechesne
2020-11-12  9:41       ` Quentin Schulz
2020-11-12  9:58         ` Nicolas Dechesne

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=27534.1605130210340595078@lists.yoctoproject.org \
    --to=shantanoo.desai@gmail.com \
    --cc=docs@lists.yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.