Skip to content

Configuring ReadtheDocs#1435

Merged
randyzwitch merged 38 commits intodevelopfrom
rtd_test
May 13, 2020
Merged

Configuring ReadtheDocs#1435
randyzwitch merged 38 commits intodevelopfrom
rtd_test

Conversation

@randyzwitch
Copy link
Copy Markdown
Contributor

@randyzwitch randyzwitch commented May 11, 2020

PR adds minimum configuration options to build on ReadtheDocs hosted environment. PR is not intended to address/remove code from make process for building/submitting doc updates in current process.

Post merging to develop, need to address the following:

  • Change docs.streamlit.io to point to RTD
  • Change admin panel settings to point to develop as latest (currently points to rtd_test for testing)
  • Decide whether to backport configuration file to version 0.59 in order to populate stable branch on documentation or wait until 0.60 comes out to keep version history consistent

@randyzwitch randyzwitch requested a review from a team as a code owner May 11, 2020 16:16
@randyzwitch randyzwitch marked this pull request as draft May 11, 2020 16:16
@randyzwitch randyzwitch marked this pull request as ready for review May 11, 2020 16:40
@tvst tvst requested a review from tconkling May 11, 2020 20:46
@tvst
Copy link
Copy Markdown
Contributor

tvst commented May 11, 2020

Tim has volunteered to review this, but let's chat before merging because I want to understand what this changes in the release process (if anything).

@randyzwitch
Copy link
Copy Markdown
Contributor Author

Thanks @tvst and @tconkling. To add a bit of clarity, merging this doesn't mean the process is changing, it gives the option to change the process. Meaning, I'm not removing the make commands for the current doc build process, and until we remap the domain to RTD, it won't make any changes to the user facing docs as they are today.

All we would need to do would be revert this commit to remove it from the codebase, should we decide this isn't the right thing to do.

Copy link
Copy Markdown
Contributor

@tconkling tconkling left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems reasonable, but I wonder about duplicating bits of our Makefile in the env_setup.sh script. It's not a huge deal, but can we use our existing build system?

@randyzwitch randyzwitch merged commit b4eacc6 into develop May 13, 2020
@randyzwitch randyzwitch deleted the rtd_test branch May 13, 2020 00:43
tconkling added a commit that referenced this pull request May 18, 2020
* develop:
  Keras model hash func (#1450)
  Add support for st.echo("below") to print echoed text below the Streamlit output (#1452)
  Update 3.5 references to 3.6 (#1444)
  PyTorch model hash func (#1445)
  Fix link for pipenv in Getting Started (#1455)
  TextArea and TextInput max_chars (#1423)
  Fix multiselect docstring example (#1442)
  Configuring ReadtheDocs (#1435)
  Fix "strip()" bug when internal IP is None (#1434)
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