Skip to content

Use a source layout in docs #1877

Open
Open
@namurphy

Description

I was playing around with Sphinx the other year, and it's now the case that when you initialize a Sphinx documentation project, it'll create a source folder that contains all of the .rst files for the content. I was thinking we could switch our docs to this source layout, since it would separate files that are not content (like docs/conf.py) with ones that are (like docs/index.rst). It would make it a little harder to get to the content in the docs, but easier to navigate through the content once you're in docs/source.

If we did this, we'd need to update the doc guide as well with probably a bunch of little changes. We'd also need to decide where some of the files should go (i.e., should bibliography.bib stay in docs or go to docs/source)?

I wanted to get feedback on this before putting any effort into it, but overall I do think it would be an improvement (and make our docs more consistent with newer Sphinx projects).

Metadata

Assignees

No one assigned

    Labels

    Plasma Lv0 | NoviceIssues that do not require knowledge of physicsPython Lv2 | IntermediateIssues that require a medium amount of knowledge of PythondocsPlasmaPy Docs at http://docs.plasmapy.orgdocumentation infrastructurepriority: lowIssues & PRs of low urgency and importance that may be deferred until laterproposalProposals that need to be decided upon before implementationstatus: on holdIssues & PRs that are being intentionally delayed

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions