Skip to content

Impoved docs build#640

Open
Phally wants to merge 6 commits into
FriendsOfCake:masterfrom
Phally:improved-docs
Open

Impoved docs build#640
Phally wants to merge 6 commits into
FriendsOfCake:masterfrom
Phally:improved-docs

Conversation

@Phally

@Phally Phally commented May 30, 2020

Copy link
Copy Markdown
Member

I've improved the docs build a bit, so that it's up-to-date and easier to contribute to it:

  1. Old Docker config and docs gave some issues, so set Docker to the latest Debian release.

  2. Added docs build and checks to Travis CI.

  3. Upgraded the docs build to Python 3.

  4. Added reStructuredText lint using RSTcheck.

  5. Fixed an issue RSTcheck flagged. See first paragraph:
    https://crud.readthedocs.io/en/latest/unit-testing.html

  6. Added Browser Sync config for easier editing.

    Does an automated build and an automated browser refresh when saving a file:

    Better resolution: https://youtu.be/NnocyVp-KHc

    Watch on YouTube

@codecov

This comment has been minimized.

@Phally Phally marked this pull request as draft May 30, 2020 13:44
@Phally Phally force-pushed the improved-docs branch 6 times, most recently from e77cd3a to cab8be0 Compare May 30, 2020 15:01
@Phally Phally changed the title Updates Docker build and documentation Impoved docs build May 30, 2020
@Phally Phally marked this pull request as ready for review May 30, 2020 18:48
@Phally

Phally commented May 30, 2020

Copy link
Copy Markdown
Member Author

Alright, this ready to be reviewed

@ADmad

ADmad commented Jun 19, 2020

Copy link
Copy Markdown
Member

@josegonzalez Is this good to merge? :)

@jippi

jippi commented Dec 4, 2020

Copy link
Copy Markdown
Member

@Phally @ADmad looks good to me once merge conflict has been fixed :)

@ADmad

ADmad commented Oct 25, 2023

Copy link
Copy Markdown
Member

@Phally Hi, would you mind re-opening this against the latest master?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants