by

Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
  • 06:29
    agjohnson synchronize #5899
  • 00:06
    stsewd review_requested #7500
  • 00:00
    stsewd synchronize #7500
  • Sep 21 23:01
    stsewd opened #7500
  • Sep 21 21:36
    stsewd closed #7490
  • Sep 21 19:41
    pyup-bot opened #7499
  • Sep 21 18:53
    humitos closed #7489
  • Sep 21 15:24
    humitos review_requested #7425
  • Sep 21 10:02
    humitos synchronize #7489
  • Sep 21 09:28
    humitos synchronize #7489
  • Sep 20 23:25
    stale[bot] labeled #7126
  • Sep 19 12:50
    saadmk11 review_requested #7243
  • Sep 19 12:37
    saadmk11 reopened #7243
  • Sep 19 12:37
    saadmk11 synchronize #7243
  • Sep 19 12:29
    saadmk11 closed #7243
  • Sep 19 12:29
    saadmk11 synchronize #7243
  • Sep 18 19:11
    srijan-deepsource edited #7495
  • Sep 18 19:07
    srijan-deepsource opened #7495
  • Sep 18 18:59
    srijan-deepsource synchronize #7494
  • Sep 18 18:46
    srijan-deepsource opened #7494
Santos Gallegos
@stsewd
@cjolowicz the first rule doesn't have any effect, since the automation rules are only evaluated for new versions (master is already created). New pushed to master should already be triggered by default
Claudio Jolowicz
@cjolowicz
I see, thanks. But why are there no builds for master then?
Santos Gallegos
@stsewd
I think you are missing to setup the github integration
Claudio Jolowicz
@cjolowicz
Indeed. Thank you! :blush:
Luis Lebolo
@lebolo

Hi all. I'm trying to see whether I can host RTD privately (behind a VPN). I spun up an EC2 instance and set it up using the Docker image and instructions here. Everything worked fine, but when I go to http://<internal_ip> to test it I get a page with the message

404 - Invalid Host
The host "<internal_ip>" is unknown to Read the Docs
If you control this domain and believe this is in error, please review our custom domain documentation. In the past, we allowed custom domains to point to us without configuring the domain in the Read the Docs dashboard and we attempted to intelligently guess the correct project based on DNS settings. Now, we believe that explicit is better than implicit. Below are some steps to help you get your domain working again:

Ensure you have a CNAME record pointing to readthedocs.io
Add your desired domain in the Read the Docs dashboard for your project (under Your Project >> Admin >> Domains)

It points me to this page, but it seems to me that those instructions assume I'm hosting my project on the public readthedocs.io site. Any ideas on how I can get this to work on my private server?

Manuel Kaufmann
@reydelhumo_twitter
hi, are you still around there?
lebolo?
Luis Lebolo
@lebolo
Hi @reydelhumo_twitter
Manuel Kaufmann
@reydelhumo_twitter
lebolo, I was about to ask you what are your needs to have your own instance of RTD? why not just use readthedocs.org?
Luis Lebolo
@lebolo
@reydelhumo_twitter: sorry, I got distracted. I was exploring our options for hosting private documentation. I know there is RTD for Business that uses authentication, etc. but is still hosted on a "public" site. We try to keep everything behind our firewall and require VPN access. So was wondering if hosting RTD locally on our servers was an option.
Ryan Mast
@nightlark
I have a version that was protected at one point. The settings have been changed to active and not hidden (we want it to show up on the flyout menu of versions available), but it still seems to be hidden and status on the settings page says it is protected. Is there a setting elsewhere that we are missing?
Santos Gallegos
@stsewd
@nightlark we dropped the privacy level concept from .org (since it was confusing, because they weren't really related to privacy...)
@nightlark we still need to drop the field from the UI. Basically, all protected versions are now hidden (this was what protected meant to be)
You can just edit the version to not be hidden, and it should be listed in the footer
Ryan Mast
@nightlark
The problem is that it is set to not be hidden, but it still isn't showing up
and the settings page says it is "protected"
I've tried toggling the setting on and off, but it doesn't seem to change anything
helics_develop_setting.PNG
Ryan Mast
@nightlark
helics_develop_protected.PNG
I also tried wiping it
Santos Gallegos
@stsewd
@nightlark I see, looks like we are still using the protected filter. Let me know what versions you want to change, so I can update them in the db till we make a proper fix
Ryan Mast
@nightlark
@stsewd the develop version is the one that we want to change; the other protected versions are temporary branches
Santos Gallegos
@stsewd
@nightlark done!
Ryan Mast
@nightlark
Thanks!
Patrick Ziegler
@patrick96
Hey everyone. I am trying to get rtd to display a warning banner on older versions of the documentation, but I can't get it to work. I have enabled "Show version warning" in "Advanced Settings" but the banner doesn't show up in any of the builds. I have also tried to disable and reenable the setting with forced builds in between and that didn't work either. Do I also need to configure something in conf.py or the rtd yaml file?
This is the doc in question and I am expecting the doc for version 3.4.0 to show that banner (and possibly the other non-stable, non-latest branches as well) but it doesn't.
Manuel Kaufmann
@reydelhumo_twitter
Hi patrick96! I recommend you to take a look at https://github.com/humitos/sphinx-version-warning
Santos Gallegos
@stsewd
@patrick96 that is because the version warning is only shown on versions that look like semver, and that are minor to the last semver version. In this case the last semver version is 3.4.0, and the other ones don't follow semver.
Patrick Ziegler
@patrick96
@stsewd Thanks for the explanation. This was indeed the only problem :)
@reydelhumo_twitter I also found that extension while researching this issue and it's definitely the next thing I'll try since I basically want the banner everywhere except for 'stable'
Michael Aye
@michaelaye
hi all! does anybody know if, and if yes, how, one can ran apidoc during the RTD build process? I don't find it mentioned in the RTD docs.
Manuel Kaufmann
@reydelhumo_twitter
michaelaye: hi! what apidoc do you refer to? sphinx-apidoc command?
Michael Aye
@michaelaye
yes!
Manuel Kaufmann
@reydelhumo_twitter
You can use it as an extension
RTD won't execute that command
Michael Aye
@michaelaye
sorry, not sure what is implied by "use it as an extension" ? If RTD doesn't execute that command, who does?
Manuel Kaufmann
@reydelhumo_twitter
Michael Aye
@michaelaye
ah, well, that's not apidoc, which is the problem. ok, so there's apparently then no way to have apidoc run on RTD?
it's kinda weird though, locally, i just use the sphinx command to launch the generation of docs, and it launches apidoc automatically as configured in conf.py. this doesn't seem to happen on RTD.
Anthony
@agjohnson
it is possible to use apidoc without manually using autodoc
we never execute the sphinx-apidoc command directly, we only execute sphinx-build
let me see if i can find an example of executing apidoc as an extension within a build. i saw one yesterday
Anthony
@agjohnson
ah someone has made an extension already: https://github.com/sphinx-contrib/apidoc
Michael Aye
@michaelaye
(sorry for the lagged reply). yes, using that, but it doesnt seem to run on RTD.
my sphinx config using apidoc as extension works fine locally, but doesnt seem to work when build on RTD.
Noômen Ben Hassin
@bnhassin
Starting markdown msg ReadTheDocs
Benjamin Balder Bach
@benjaoming

Hi friends! I was wondering if you can clarify if readthedocs.readthedocs.io is some kind of a hack? Running wget on it does this:

➜ ~ wget readthedocs.readthedocs.io
--2020-09-10 13:30:47-- http://readthedocs.readthedocs.io/
...
Location: https://readthedocs.readthedocs.io/ [following]
...
Location: http://docs.mio-lang.org/zh_CN/latest/ [following]
--2020-09-10 13:30:47-- http://docs.mio-lang.org/zh_CN/latest/
Resolving docs.mio-lang.org (docs.mio-lang.org)... 142.93.232.95
Connecting to docs.mio-lang.org (docs.mio-lang.org)|142.93.232.95|:80... connected.
HTTP request sent, awaiting response... 200 OK
Length: unspecified [text/html]
Saving to: ‘index.html’

Looking at the site, it seems that behaves like a multilingual Read the Docs project, but the contents are spammy/fishy?

Santos Gallegos
@stsewd
That means there is a project named readthedocs (https://readthedocs.org/projects/readthedocs/) with a custom domain (docs.mio-lang.org)
if the domain is marked as canonical we redirect to that domain